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. More...

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

	KVBase (const KVBase &)
	copy ctor More...

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

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

const Char_t *	GetLabel () const

UInt_t	GetNumber () const

virtual TObject *	GetObject () const

virtual const Char_t *	GetType () const

Bool_t	HasLabel () const

Bool_t	IsCalled (const Char_t *name, bool case_insensitive=false) const

Bool_t	IsLabelled (const Char_t *l, bool case_insensitive=false) const

Bool_t	IsType (const Char_t *typ, bool case_insensitive=false) const

virtual void	List ()

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

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

void	SetLabel (const Char_t *lab)

virtual void	SetNumber (UInt_t num)

virtual void	SetType (const Char_t *str)

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

enum class	GetX_status { ok , above_maximum , below_minimum , at_maximum , at_minimum }

Static Public Member Functions inherited from KVBase
static std::optional< TString >	AbsoluteUnixPath (const TString &)

static Bool_t	AreEqual (Double_t x, Double_t y, Long64_t maxdif=1)
	Comparison between two 64-bit floating-point values. More...

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 KVString &class_name, KVString &imp_file, KVString &dec_file, const KVString &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="")

template<typename ValType >
static ValType	GetDataSetEnv (const KVString &dataset, const KVString &type, const ValType &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.) More...

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

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

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

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

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

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

static int	GetKVMajorVersion ()

static int	GetKVMinorVersion ()

static int	GetKVPatchVersion ()

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

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

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. More...

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

static void	InitEnvironment ()

static bool	is_gnuinstall ()

static Bool_t	IsEnvInit ()

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. More...

static Double_t	ProtectedGetX (const TF1 &func, Double_t val, GetX_status &status, std::optional< Double_t > xmin={}, std::optional< Double_t > xmax={})

static Double_t	ProtectedGetX (const TF1 *func, Double_t val, GetX_status &status, std::optional< Double_t > xmin={}, std::optional< Double_t > xmax={})

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 ()

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

◆ ExcludeStartNode()

void KVGeoNodeIterator::ExcludeStartNode ( Bool_t u = kTRUE )

inline

Exclude start node from iteration

Definition at line 83 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.

Detailed Description

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ KVGeoNodeIterator()

◆ ~KVGeoNodeIterator()

Member Function Documentation

◆ ExcludeStartNode()

◆ IterateBackwards()

◆ operator()()

◆ Reset()

◆ ResetTrajectory()