Detailed Description

Iterate from node to node along trajectories in array geometry.

Created by KVClassFactory on Mon Oct 5 17:32:21 2015 Author: John Frankland,,,

Use a KVGeoNodeIterator in order to iterate over all nodes on all trajectories starting from a given node:

KVGeoDetectorNode* start; =//= node to start iteration from
 
KVGeoNodeIterator next_node(start);
KVGeoDetectorNode* node;
 
while( (node = next_node()) ){
   =//= do something to each node
}

Note that the start node for the iteration is included, and will be iterated over at the beginning of each trajectory. To exclude the start node from the iteration, call method ExcludeStartNode(kTRUE) before iteration begins.

Default direction for iteration is FORWARDS i.e. moving towards the target. To change direction, call method IterateBackwards(kTRUE) before iteration begins.

Definition at line 37 of file KVGeoNodeIterator.h.

#include <KVGeoNodeIterator.h>

Inheritance diagram for KVGeoNodeIterator:

[legend]

Public Member Functions
	KVGeoNodeIterator (KVGeoDetectorNode start, KVGeoDNTrajectory trajectory=nullptr)

virtual	~KVGeoNodeIterator ()

void	ExcludeStartNode (Bool_t u=kTRUE)

void	IterateBackwards (Bool_t i=kTRUE)

KVGeoDetectorNode *	operator() (void) const

void	Reset (KVGeoDetectorNode start=nullptr, KVGeoDNTrajectory trajectory=nullptr)

void	ResetTrajectory (KVGeoDNTrajectory *trajectory=nullptr)

Public Member Functions inherited from KVBase
	KVBase ()
	Default constructor.

	KVBase (const Char_t name, const Char_t title="")
	Ctor for object with given name and type.

	KVBase (const KVBase &)
	copy ctor

virtual	~KVBase ()

virtual void	Clear (Option_t *opt="")
	Clear object properties : name, type/title, number, label.

virtual void	Copy (TObject &) const
	Make a copy of this object.

const Char_t *	GetLabel () const

UInt_t	GetNumber () const

UInt_t	GetNumberOfObjects () const

virtual TObject *	GetObject () const

virtual const Char_t *	GetType () const

Bool_t	HasLabel () const

virtual Bool_t	IsCalled (const Char_t *name) const

Bool_t	IsLabelled (const Char_t *l) const

virtual Bool_t	IsType (const Char_t *typ) const

virtual void	List ()

KVBase &	operator= (const KVBase &)
	copy assignment operator

virtual void	Print (Option_t *option="") const

Double_t	ProtectedGetX (const TF1 *func, Double_t val, int &status, Double_t xmin=0.0, Double_t xmax=0.0) const

void	SetLabel (const Char_t *lab)

virtual void	SetNumber (UInt_t num)

virtual void	SetType (const Char_t *str)

Public Member Functions inherited from TNamed
	TNamed ()

	TNamed (const char name, const char title)

	TNamed (const TNamed &named)

	TNamed (const TString &name, const TString &title)

virtual	~TNamed ()

void	Clear (Option_t *option="") override

TObject *	Clone (const char *newname="") const override

Int_t	Compare (const TObject *obj) const override

void	Copy (TObject &named) const override

virtual void	FillBuffer (char *&buffer)

const char *	GetName () const override

const char *	GetTitle () const override

ULong_t	Hash () const override

TClass *	IsA () const override

Bool_t	IsSortable () const override

void	ls (Option_t *option="") const override

TNamed &	operator= (const TNamed &rhs)

void	Print (Option_t *option="") const override

virtual void	SetName (const char *name)

virtual void	SetNameTitle (const char name, const char title)

virtual void	SetTitle (const char *title="")

virtual Int_t	Sizeof () const

void	Streamer (TBuffer &) override

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

Public Member Functions inherited from TObject
	TObject ()

	TObject (const TObject &object)

virtual	~TObject ()

void	AbstractMethod (const char *method) const

virtual void	AppendPad (Option_t *option="")

virtual void	Browse (TBrowser *b)

ULong_t	CheckedHash ()

virtual const char *	ClassName () const

virtual void	Delete (Option_t *option="")

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)

virtual void	Draw (Option_t *option="")

virtual void	DrawClass () const

virtual TObject *	DrawClone (Option_t *option="") const

virtual void	Dump () const

virtual void	Error (const char method, const char msgfmt,...) const

virtual void	Execute (const char method, const char params, Int_t *error=nullptr)

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=nullptr)

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)

virtual void	Fatal (const char method, const char msgfmt,...) const

virtual TObject *	FindObject (const char *name) const

virtual TObject *	FindObject (const TObject *obj) const

virtual Option_t *	GetDrawOption () const

virtual const char *	GetIconName () const

virtual char *	GetObjectInfo (Int_t px, Int_t py) const

virtual Option_t *	GetOption () const

virtual UInt_t	GetUniqueID () const

virtual Bool_t	HandleTimer (TTimer *timer)

Bool_t	HasInconsistentHash () const

virtual void	Info (const char method, const char msgfmt,...) const

virtual Bool_t	InheritsFrom (const char *classname) const

virtual Bool_t	InheritsFrom (const TClass *cl) const

virtual void	Inspect () const

void	InvertBit (UInt_t f)

Bool_t	IsDestructed () const

virtual Bool_t	IsEqual (const TObject *obj) const

virtual Bool_t	IsFolder () const

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

void	MayNotUse (const char *method) const

virtual Bool_t	Notify ()

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const

void	operator delete (void *ptr)

void	operator delete (void ptr, void vp)

void	operator delete[] (void *ptr)

void	operator delete[] (void ptr, void vp)

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, void *vp)

TObject &	operator= (const TObject &rhs)

virtual void	Paint (Option_t *option="")

virtual void	Pop ()

virtual Int_t	Read (const char *name)

virtual void	RecursiveRemove (TObject *obj)

void	ResetBit (UInt_t f)

virtual void	SaveAs (const char filename="", Option_t option="") const

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)

virtual void	SetDrawOption (Option_t *option="")

virtual void	SetUniqueID (UInt_t uid)

void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)

virtual void	SysError (const char method, const char msgfmt,...) const

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

virtual void	UseCurrentStyle ()

virtual void	Warning (const char method, const char msgfmt,...) const

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)

virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const

Private Member Functions
void	begin_iteration_on_next_trajectory () const

void	get_next_node_on_current_trajectory () const

Private Attributes
KVGeoDetectorNode *	current_node

KVGeoDNTrajectory *	current_trajectory

Bool_t	exclude_start_node

KVGeoDNTrajectory *	iter_on_traj
	limit iteration to this trajectory, if given

Bool_t	iterate_backwards

TIter *	next_trajectory

KVGeoDetectorNode *	start_node

Additional Inherited Members
Public Types inherited from KVBase
enum	EKaliVedaBits { kIsKaliVedaObject = BIT(23) }

Public Types inherited from TObject
enum	EDeprecatedStatusBits

enum	EStatusBits

Static Public Member Functions inherited from KVBase
static Bool_t	AreEqual (Double_t x, Double_t y, Long64_t maxdif=1)
	Comparison between two 64-bit floating-point values.

static void	BackupFileWithDate (const Char_t *path)

static void	CombineFiles (const Char_t file1, const Char_t file2, const Char_t *newfilename, Bool_t keep=kTRUE)

static void	Deprecated (const char method, const char advice)

static Bool_t	FindClassSourceFiles (const Char_t class_name, KVString &imp_file, KVString &dec_file, const Char_t dir_name=".")

static Bool_t	FindExecutable (TString &exec, const Char_t *path="$(PATH)")

static const Char_t *	FindFile (const Char_t *search, TString &wfil)

static const Char_t *	GetBINDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetDATABASEFilePath ()

static const Char_t *	GetDATADIRFilePath (const Char_t *namefile="")

static Bool_t	GetDataSetEnv (const Char_t dataset, const Char_t type, Bool_t defval)

static const Char_t *	GetDataSetEnv (const Char_t dataset, const Char_t type, const Char_t *defval)

static Double_t	GetDataSetEnv (const Char_t dataset, const Char_t type, Double_t defval)

static const Char_t *	GetETCDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetExampleFilePath (const Char_t library, const Char_t namefile)
	Return full path to example file for given library (="KVMultiDet", "BackTrack", etc.)

static const Char_t *	GetINCDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetKVBuildDate ()
	Returns KaliVeda build date.

static const Char_t *	GetKVBuildDir ()
	Returns top-level directory used for build.

static const Char_t *	GetKVBuildTime ()
	Returns KaliVeda build time.

static const Char_t *	GetKVBuildType ()
	Returns KaliVeda build type (cmake build: Release, Debug, RelWithDebInfo, ...)

static const Char_t *	GetKVBuildUser ()
	Returns username of person who performed build.

static const Char_t *	GetKVSourceDir ()
	Returns top-level directory of source tree used for build.

static const Char_t *	GetKVVersion ()
	Returns KaliVeda version string.

static const Char_t *	GetLIBDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetListOfPlugins (const Char_t *base)

static const Char_t *	GetListOfPluginURIs (const Char_t *base)

static const Char_t *	GetPluginURI (const Char_t base, const Char_t plugin)

static void	GetTempFileName (TString &base)

static const Char_t *	GetTEMPLATEDIRFilePath (const Char_t *namefile="")

static const Char_t *	GetWORKDIRFilePath (const Char_t *namefile="")

static const Char_t *	gitBranch ()
	Returns git branch of sources.

static const Char_t *	gitCommit ()
	Returns last git commit of sources.

static void	InitEnvironment ()

static bool	is_gnuinstall ()

static Bool_t	IsThisAPlugin (const TString &uri, TString &base)

static TPluginHandler *	LoadPlugin (const Char_t base, const Char_t uri="0")

static Bool_t	OpenContextMenu (const char method, TObject obj, const char *alt_method_name="")

static void	OpenTempFile (TString &base, std::ofstream &fp)

static void	PrintSplashScreen ()
	Prints welcome message and infos on version etc.

static Bool_t	SearchAndOpenKVFile (const Char_t name, KVSQLite::database &dbfile, const Char_t kvsubdir="")

static Bool_t	SearchAndOpenKVFile (const Char_t name, std::ifstream &file, const Char_t kvsubdir="", KVLockfile *locks=0)

static Bool_t	SearchAndOpenKVFile (const Char_t name, std::ofstream &file, const Char_t kvsubdir="", KVLockfile *locks=0)

static Bool_t	SearchKVFile (const Char_t name, TString &fullpath, const Char_t kvsubdir="")

static const Char_t *	WorkingDirectory ()

Static Public Member Functions inherited from TNamed
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

Static Public Member Functions inherited from TObject
static TClass *	Class ()

static const char *	Class_Name ()

static constexpr Version_t	Class_Version ()

static const char *	DeclFileName ()

static Longptr_t	GetDtorOnly ()

static Bool_t	GetObjectStat ()

static void	SetDtorOnly (void *obj)

static void	SetObjectStat (Bool_t stat)

Public Attributes inherited from TObject
	kBitMask

	kCanDelete

	kCannotPick

	kHasUUID

	kInconsistent

	kInvalidObject

	kIsOnHeap

	kIsReferenced

	kMustCleanup

	kNoContextMenu

	kNotDeleted

	kObjInCanvas

	kOverwrite

	kSingleKey

	kWriteDelete

	kZombie

Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const

void	MakeZombie ()

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Protected Attributes inherited from TObject
	kOnlyPrepStep

Constructor & Destructor Documentation

◆ KVGeoNodeIterator()

KVGeoNodeIterator::KVGeoNodeIterator	(	KVGeoDetectorNode *	start,
		KVGeoDNTrajectory *	trajectory = `nullptr`
	)

inline

Begin an iteration over nodes starting at 'start' If 'trajectory' is given, only nodes on 'trajectory' will be followed Otherwise, all trajectories will be followed

Definition at line 67 of file KVGeoNodeIterator.h.

◆ ~KVGeoNodeIterator()

virtual KVGeoNodeIterator::~KVGeoNodeIterator ( )

inlinevirtual

Definition at line 78 of file KVGeoNodeIterator.h.

Member Function Documentation

◆ begin_iteration_on_next_trajectory()

void KVGeoNodeIterator::begin_iteration_on_next_trajectory ( ) const

inlineprivate

Definition at line 46 of file KVGeoNodeIterator.h.

◆ ExcludeStartNode()

void KVGeoNodeIterator::ExcludeStartNode ( Bool_t u = kTRUE )

inline

Exclude start node from iteration

Definition at line 83 of file KVGeoNodeIterator.h.

◆ get_next_node_on_current_trajectory()

void KVGeoNodeIterator::get_next_node_on_current_trajectory ( ) const

inlineprivate

Definition at line 59 of file KVGeoNodeIterator.h.

◆ IterateBackwards()

void KVGeoNodeIterator::IterateBackwards ( Bool_t i = kTRUE )

inline

Perform all iterations backwards i.e. move away from target

Definition at line 88 of file KVGeoNodeIterator.h.

◆ operator()()

KVGeoDetectorNode * KVGeoNodeIterator::operator() ( void ) const

inline

Return next node in iteration

Definition at line 94 of file KVGeoNodeIterator.h.

◆ Reset()

void KVGeoNodeIterator::Reset	(	KVGeoDetectorNode *	start = `nullptr`,
		KVGeoDNTrajectory *	trajectory = `nullptr`
	)

Reset the iterator in order to perform a new iteration:

it.Reset(); => iterate from same node on same trajectory(ies) i.e. if you originally specified a trajectory to iterate over, it will be used again. If you want to iterate from the same node but now lifting the restriction on the trajectory, call it.ResetTrajectory()

it.Reset(start); => iterate from a new node, using all trajectories

it.Reset(start,trajectory) => iterate from a new node using given trajectory

Definition at line 24 of file KVGeoNodeIterator.cpp.

◆ ResetTrajectory()

void KVGeoNodeIterator::ResetTrajectory ( KVGeoDNTrajectory * trajectory = nullptr )

Reset the iterator in order to perform a new iteration starting from the same node but either with a different trajectory, or lifting the restriction on the trajectory originally given to the constructor:

KVGeoNodeIterator it(start,trajectory); while( (KVGeoDetectorNode* n = it()) ){ iterate only over 'trajectory' } it.ResetTrajectory(); while( (KVGeoDetectorNode* n = it()) ){ iterate over all trajectories } it.ResetTrajectory(trajectory2); while( (KVGeoDetectorNode* n = it()) ){ iterate only over 'trajectory2' }

Definition at line 72 of file KVGeoNodeIterator.cpp.

Member Data Documentation

◆ current_node

KVGeoDetectorNode* KVGeoNodeIterator::current_node

mutableprivate

Definition at line 39 of file KVGeoNodeIterator.h.

◆ current_trajectory

KVGeoDNTrajectory* KVGeoNodeIterator::current_trajectory

mutableprivate

Definition at line 42 of file KVGeoNodeIterator.h.

◆ exclude_start_node

Bool_t KVGeoNodeIterator::exclude_start_node

private

Definition at line 43 of file KVGeoNodeIterator.h.

◆ iter_on_traj

KVGeoDNTrajectory* KVGeoNodeIterator::iter_on_traj

private

limit iteration to this trajectory, if given

Definition at line 40 of file KVGeoNodeIterator.h.

◆ iterate_backwards

Bool_t KVGeoNodeIterator::iterate_backwards

private

Definition at line 44 of file KVGeoNodeIterator.h.

◆ next_trajectory

TIter* KVGeoNodeIterator::next_trajectory

private

Definition at line 41 of file KVGeoNodeIterator.h.

◆ start_node

KVGeoDetectorNode* KVGeoNodeIterator::start_node

private

Definition at line 38 of file KVGeoNodeIterator.h.

Detailed Description

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ KVGeoNodeIterator()

◆ ~KVGeoNodeIterator()

Member Function Documentation

◆ begin_iteration_on_next_trajectory()

◆ ExcludeStartNode()

◆ get_next_node_on_current_trajectory()

◆ IterateBackwards()

◆ operator()()

◆ Reset()

◆ ResetTrajectory()

Member Data Documentation

◆ current_node

◆ current_trajectory

◆ exclude_start_node

◆ iter_on_traj

◆ iterate_backwards

◆ next_trajectory

◆ start_node