An array of daughter indices making a geometry path.

Can be used to backup/restore a state. Allocated contiguously in memory.

To setup an object of this type, one should use:

TGeoBranchArray *array = new TGeoBranchArray(level);

array->InitFromNavigator(nav); // To initialize from current navigator state

TGeoBranchArray

An array of daughter indices making a geometry path.

Definition TGeoBranchArray.h:23

TGeoBranchArray::InitFromNavigator

void InitFromNavigator(TGeoNavigator *nav)

Init the branch array from current navigator state.

Definition TGeoBranchArray.cxx:334

The navigator can be updated to reflect this path array: array->UpdateNavigator();

Definition at line 22 of file TGeoBranchArray.h.

Public Types
enum	EGeoBATypes { kBASelfAlloc = BIT(14) }

Public Types inherited from TObject
enum	{ kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff }

enum	{ kSingleKey = BIT(0) , kOverwrite = BIT(1) , kWriteDelete = BIT(2) }

enum	EDeprecatedStatusBits { kObjInCanvas = BIT(3) }

enum	EStatusBits { kCanDelete = BIT(0) , kMustCleanup = BIT(3) , kIsReferenced = BIT(4) , kHasUUID = BIT(5) , kCannotPick = BIT(6) , kNoContextMenu = BIT(8) , kInvalidObject = BIT(13) }

Public Member Functions
	TGeoBranchArray (TRootIOCtor *)

virtual	~TGeoBranchArray ()

void	AddLevel (Int_t dindex)
	Add and extra daughter to the current path array. No validity check performed !

void	CleanMatrix ()
	Garbage collect the stored matrix.

virtual Int_t	Compare (const TObject *obj) const
	Compare with other object of same type.

void	CopyTo (TGeoBranchArray *dest)
	Raw memcpy of the branch array content to an existing destination.

size_t	DataSize () const

void *	DataStart () const

TGeoNode **	GetArray () const

TGeoNode *	GetCurrentNode () const

size_t	GetLevel () const

const TGeoHMatrix *	GetMatrix () const

size_t	GetMaxLevel () const

TGeoNode *	GetNode (Int_t level) const

void	GetPath (TString &path) const
	Fill path pointed by the array.

void	Init (TGeoNode *branch, TGeoMatrix global, Int_t level)
	Init the branch array from an array of nodes, the global matrix for the path and the level.

void	InitFromNavigator (TGeoNavigator *nav)
	Init the branch array from current navigator state.

Bool_t	IsOutside () const

virtual Bool_t	IsSortable () const

Bool_t	operator!= (const TGeoBranchArray &other) const
	Not equal operator.

Bool_t	operator< (const TGeoBranchArray &other) const
	Is equal operator.

Bool_t	operator<= (const TGeoBranchArray &other) const
	Is equal operator.

TGeoBranchArray &	operator= (const TGeoBranchArray &)
	Assignment. Not valid anymore. Use TGeoBranchArray::MakeCopy instead.

Bool_t	operator== (const TGeoBranchArray &other) const
	Is equal operator.

Bool_t	operator> (const TGeoBranchArray &other) const
	Is equal operator.

Bool_t	operator>= (const TGeoBranchArray &other) const
	Is equal operator.

virtual void	Print (Option_t *option="") const
	Print branch information.

size_t	SizeOf () const

void	UpdateArray (size_t nobj)
	Updates the internal addresses for n contiguous objects which have the same fMaxLevel Updates the internal addresses for n contiguous objects which have the same fMaxLevel.

void	UpdateNavigator (TGeoNavigator *nav) const
	Update the navigator to reflect the branch.

Public Member Functions inherited from TObject
	TObject ()
	TObject constructor.

	TObject (const TObject &object)
	TObject copy ctor.

virtual	~TObject ()
	TObject destructor.

void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract.

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad.

virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action.

ULong_t	CheckedHash ()
	Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.

virtual const char *	ClassName () const
	Returns name of class to which the object belongs.

virtual void	Clear (Option_t *="")

virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility.

virtual void	Copy (TObject &object) const
	Copy this to obj.

virtual void	Delete (Option_t *option="")
	Delete this object.

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object.

virtual void	Draw (Option_t *option="")
	Default Draw method for all objects.

virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs.

virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad for instance with: `gROOT->SetSelectedPad(gPad)`.

virtual void	Dump () const
	Dump contents of object on stdout.

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message.

virtual void	Execute (const char method, const char params, Int_t *error=0)
	Execute method on this object with the given parameter string, e.g.

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=0)
	Execute method on this object with parameters stored in the TObjArray.

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py).

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message.

virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.

virtual const char *	GetIconName () const
	Returns mime type name of object.

virtual const char *	GetName () const
	Returns name of object.

virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py).

virtual Option_t *	GetOption () const

virtual const char *	GetTitle () const
	Returns title of object.

virtual UInt_t	GetUniqueID () const
	Return the unique object id.

virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out.

virtual ULong_t	Hash () const
	Return hash value for this object.

Bool_t	HasInconsistentHash () const
	Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message.

virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname".

virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl.

virtual void	Inspect () const
	Dump contents of this object in a graphics canvas.

void	InvertBit (UInt_t f)

Bool_t	IsDestructed () const
	IsDestructed.

virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory).

virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

virtual void	ls (Option_t *option="") const
	The ls function lists the contents of a class on stdout.

void	MayNotUse (const char *method) const
	Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification.

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete.

void	operator delete (void *ptr)
	Operator delete.

void	operator delete[] (void *ptr)
	Operator delete [].

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)
	TObject assignment operator.

virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself.

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list.

virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory.

virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list.

void	ResetBit (UInt_t f)

virtual void	SaveAs (const char filename="", Option_t option="") const
	Save this object in the file specified by filename.

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out".

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f.

virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object.

virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.

virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message.

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

virtual void	UseCurrentStyle ()
	Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.

virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message.

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Static Public Member Functions
static Long64_t	BinarySearch (Long64_t n, const TGeoBranchArray *array, TGeoBranchArray value)
	Binary search in an array of n pointers to branch arrays, to locate value.

static TGeoBranchArray *	MakeCopy (const TGeoBranchArray &other)
	Make a copy of a branch array at the location (if indicated)

static TGeoBranchArray *	MakeCopyAt (const TGeoBranchArray &other, void *addr)
	Make a copy of a branch array at the location (if indicated)

static TGeoBranchArray *	MakeInstance (size_t maxlevel)
	Make an instance of the class which allocates the node array.

static TGeoBranchArray *	MakeInstanceAt (size_t maxlevel, void *addr)
	Make an instance of the class which allocates the node array.

static void	ReleaseInstance (TGeoBranchArray *obj)
	Releases the space allocated for the object.

static size_t	SizeOf (size_t maxlevel)

static size_t	SizeOfInstance (size_t maxlevel)

static void	Sort (Int_t n, TGeoBranchArray *array, Int_t index, Bool_t down=kTRUE)
	Sorting of an array of branch array pointers.

Static Public Member Functions inherited from TObject
static Longptr_t	GetDtorOnly ()
	Return destructor only flag.

static Bool_t	GetObjectStat ()
	Get status of object stat flag.

static void	SetDtorOnly (void *obj)
	Set destructor only flag.

static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable.

Protected Attributes
TGeoNode **	fArray

Int_t	fLevel

TGeoHMatrix	fMatrix

Int_t	fMaxLevel

TGeoNode *	fRealArray [1]
	[fMaxLevel+1] Array of nodes

Private Member Functions
	TGeoBranchArray (const TGeoBranchArray &)
	Copy constructor. Not callable anymore. Use TGeoBranchArray::MakeCopy instead.

	TGeoBranchArray (Int_t level)
	Constructor. Allocates the array with a size given by level.

Additional Inherited Members
Protected Types inherited from TObject
enum	{ kOnlyPrepStep = BIT(3) }

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

void	MakeZombie ()

#include <TGeoBranchArray.h>

Inheritance diagram for TGeoBranchArray:

[legend]

Member Enumeration Documentation

◆ EGeoBATypes

enum TGeoBranchArray::EGeoBATypes

Enumerator
kBASelfAlloc

Definition at line 35 of file TGeoBranchArray.h.

Constructor & Destructor Documentation

◆ TGeoBranchArray() [1/3]

TGeoBranchArray::TGeoBranchArray ( Int_t level )

private

Constructor. Allocates the array with a size given by level.

Definition at line 41 of file TGeoBranchArray.cxx.

◆ TGeoBranchArray() [2/3]

TGeoBranchArray::TGeoBranchArray ( const TGeoBranchArray & other )

private

Copy constructor. Not callable anymore. Use TGeoBranchArray::MakeCopy instead.

Definition at line 157 of file TGeoBranchArray.cxx.

◆ TGeoBranchArray() [3/3]

TGeoBranchArray::TGeoBranchArray ( TRootIOCtor * )

inline

Definition at line 40 of file TGeoBranchArray.h.

◆ ~TGeoBranchArray()

virtual TGeoBranchArray::~TGeoBranchArray ( )

inlinevirtual

Definition at line 86 of file TGeoBranchArray.h.

Member Function Documentation

◆ AddLevel()

void TGeoBranchArray::AddLevel ( Int_t dindex )

Add and extra daughter to the current path array. No validity check performed !

Definition at line 185 of file TGeoBranchArray.cxx.

◆ BinarySearch()

Long64_t TGeoBranchArray::BinarySearch	(	Long64_t	n,
		const TGeoBranchArray **	array,
		TGeoBranchArray *	value
	)

static

Binary search in an array of n pointers to branch arrays, to locate value.

Returns element index or index of nearest element smaller than value

Definition at line 271 of file TGeoBranchArray.cxx.

◆ CleanMatrix()

void TGeoBranchArray::CleanMatrix ( )

Garbage collect the stored matrix.

Definition at line 312 of file TGeoBranchArray.cxx.

◆ Compare()

Int_t TGeoBranchArray::Compare ( const TObject * obj ) const

virtual

Compare with other object of same type.

Returns -1 if this is smaller (first smaller array value prevails), 0 if equal (size and values) and 1 if this is larger.

Reimplemented from TObject.

Definition at line 292 of file TGeoBranchArray.cxx.

◆ CopyTo()

void TGeoBranchArray::CopyTo ( TGeoBranchArray * dest )

Raw memcpy of the branch array content to an existing destination.

Definition at line 119 of file TGeoBranchArray.cxx.

◆ DataSize()

size_t TGeoBranchArray::DataSize ( ) const

inline

Definition at line 79 of file TGeoBranchArray.h.

◆ DataStart()

void * TGeoBranchArray::DataStart ( ) const

inline

Definition at line 76 of file TGeoBranchArray.h.

◆ GetArray()

TGeoNode ** TGeoBranchArray::GetArray ( ) const

inline

Definition at line 99 of file TGeoBranchArray.h.

◆ GetCurrentNode()

TGeoNode * TGeoBranchArray::GetCurrentNode ( ) const

inline

Definition at line 105 of file TGeoBranchArray.h.

◆ GetLevel()

size_t TGeoBranchArray::GetLevel ( ) const

inline

Definition at line 100 of file TGeoBranchArray.h.

◆ GetMatrix()

const TGeoHMatrix * TGeoBranchArray::GetMatrix ( ) const

inline

Definition at line 103 of file TGeoBranchArray.h.

◆ GetMaxLevel()

size_t TGeoBranchArray::GetMaxLevel ( ) const

inline

Definition at line 101 of file TGeoBranchArray.h.

◆ GetNode()

TGeoNode * TGeoBranchArray::GetNode ( Int_t level ) const

inline

Definition at line 104 of file TGeoBranchArray.h.

◆ GetPath()

void TGeoBranchArray::GetPath ( TString & path ) const

Fill path pointed by the array.

Definition at line 352 of file TGeoBranchArray.cxx.

◆ Init()

void TGeoBranchArray::Init	(	TGeoNode **	branch,
		TGeoMatrix *	global,
		Int_t	level
	)

Init the branch array from an array of nodes, the global matrix for the path and the level.

Definition at line 320 of file TGeoBranchArray.cxx.

◆ InitFromNavigator()

void TGeoBranchArray::InitFromNavigator ( TGeoNavigator * nav )

Init the branch array from current navigator state.

Definition at line 334 of file TGeoBranchArray.cxx.

◆ IsOutside()

Bool_t TGeoBranchArray::IsOutside ( ) const

inline

Definition at line 110 of file TGeoBranchArray.h.

◆ IsSortable()

virtual Bool_t TGeoBranchArray::IsSortable ( ) const

inlinevirtual

Reimplemented from TObject.

Definition at line 109 of file TGeoBranchArray.h.

◆ MakeCopy()

TGeoBranchArray * TGeoBranchArray::MakeCopy ( const TGeoBranchArray & other )

static

Make a copy of a branch array at the location (if indicated)

Definition at line 85 of file TGeoBranchArray.cxx.

◆ MakeCopyAt()

TGeoBranchArray * TGeoBranchArray::MakeCopyAt	(	const TGeoBranchArray &	other,
		void *	addr
	)

static

Make a copy of a branch array at the location (if indicated)

Definition at line 103 of file TGeoBranchArray.cxx.

◆ MakeInstance()

TGeoBranchArray * TGeoBranchArray::MakeInstance ( size_t maxlevel )

static

Make an instance of the class which allocates the node array.

To be released using ReleaseInstance. If addr is non-zero, the user promised that addr contains at least that many bytes: size_t needed = SizeOf(maxlevel);

Definition at line 55 of file TGeoBranchArray.cxx.

◆ MakeInstanceAt()

TGeoBranchArray * TGeoBranchArray::MakeInstanceAt	(	size_t	maxlevel,
		void *	addr
	)

static

Make an instance of the class which allocates the node array.

To be released using ReleaseInstance. If addr is non-zero, the user promised that addr contains at least that many bytes: size_t needed = SizeOf(maxlevel);

Definition at line 72 of file TGeoBranchArray.cxx.

◆ operator!=()

Bool_t TGeoBranchArray::operator!= ( const TGeoBranchArray & other ) const

Not equal operator.

Definition at line 220 of file TGeoBranchArray.cxx.

◆ operator<()

Bool_t TGeoBranchArray::operator< ( const TGeoBranchArray & other ) const

Is equal operator.

Definition at line 240 of file TGeoBranchArray.cxx.

◆ operator<=()

Bool_t TGeoBranchArray::operator<= ( const TGeoBranchArray & other ) const

Is equal operator.

Definition at line 260 of file TGeoBranchArray.cxx.

◆ operator=()

TGeoBranchArray & TGeoBranchArray::operator= ( const TGeoBranchArray & other )

Assignment. Not valid anymore. Use TGeoBranchArray::MakeCopy instead.

Definition at line 173 of file TGeoBranchArray.cxx.

◆ operator==()

Bool_t TGeoBranchArray::operator== ( const TGeoBranchArray & other ) const

Is equal operator.

Definition at line 210 of file TGeoBranchArray.cxx.

◆ operator>()

Bool_t TGeoBranchArray::operator> ( const TGeoBranchArray & other ) const

Is equal operator.

Definition at line 230 of file TGeoBranchArray.cxx.

◆ operator>=()

Bool_t TGeoBranchArray::operator>= ( const TGeoBranchArray & other ) const

Is equal operator.

Definition at line 250 of file TGeoBranchArray.cxx.

◆ Print()

void TGeoBranchArray::Print ( Option_t * option = "" ) const

virtual

Print branch information.

Reimplemented from TObject.

Definition at line 365 of file TGeoBranchArray.cxx.

◆ ReleaseInstance()

void TGeoBranchArray::ReleaseInstance ( TGeoBranchArray * obj )

static

Releases the space allocated for the object.

Definition at line 128 of file TGeoBranchArray.cxx.

◆ SizeOf() [1/2]

size_t TGeoBranchArray::SizeOf ( ) const

inline

Definition at line 71 of file TGeoBranchArray.h.

◆ SizeOf() [2/2]

static size_t TGeoBranchArray::SizeOf ( size_t maxlevel )

inlinestatic

Definition at line 64 of file TGeoBranchArray.h.

◆ SizeOfInstance()

static size_t TGeoBranchArray::SizeOfInstance ( size_t maxlevel )

inlinestatic

Definition at line 68 of file TGeoBranchArray.h.

◆ Sort()

void TGeoBranchArray::Sort	(	Int_t	n,
		TGeoBranchArray **	array,
		Int_t *	index,
		Bool_t	down = `kTRUE`
	)

static

Sorting of an array of branch array pointers.

Definition at line 375 of file TGeoBranchArray.cxx.

◆ UpdateArray()

void TGeoBranchArray::UpdateArray ( size_t nobj )

Updates the internal addresses for n contiguous objects which have the same fMaxLevel Updates the internal addresses for n contiguous objects which have the same fMaxLevel.

Definition at line 139 of file TGeoBranchArray.cxx.

◆ UpdateNavigator()

void TGeoBranchArray::UpdateNavigator ( TGeoNavigator * nav ) const

Update the navigator to reflect the branch.

nav->CdTop();

Definition at line 388 of file TGeoBranchArray.cxx.

Member Data Documentation

◆ fArray

TGeoNode** TGeoBranchArray::fArray

protected

Definition at line 28 of file TGeoBranchArray.h.

◆ fLevel

Int_t TGeoBranchArray::fLevel

protected

Definition at line 25 of file TGeoBranchArray.h.

◆ fMatrix

TGeoHMatrix TGeoBranchArray::fMatrix

protected

Definition at line 27 of file TGeoBranchArray.h.

◆ fMaxLevel

Int_t TGeoBranchArray::fMaxLevel

protected

Definition at line 26 of file TGeoBranchArray.h.

◆ fRealArray

TGeoNode* TGeoBranchArray::fRealArray[1]

protected

[fMaxLevel+1] Array of nodes

Definition at line 29 of file TGeoBranchArray.h.

Libraries for TGeoBranchArray:

[legend]

The documentation for this class was generated from the following files:

geom/geom/inc/TGeoBranchArray.h
geom/geom/src/TGeoBranchArray.cxx

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Member Enumeration Documentation

◆ EGeoBATypes

Constructor & Destructor Documentation

◆ TGeoBranchArray() [1/3]

◆ TGeoBranchArray() [2/3]

◆ TGeoBranchArray() [3/3]

◆ ~TGeoBranchArray()

Member Function Documentation

◆ AddLevel()

◆ BinarySearch()

◆ CleanMatrix()

◆ Compare()

◆ CopyTo()

◆ DataSize()

◆ DataStart()

◆ GetArray()

◆ GetCurrentNode()

◆ GetLevel()

◆ GetMatrix()

◆ GetMaxLevel()

◆ GetNode()

◆ GetPath()

◆ Init()

◆ InitFromNavigator()

◆ IsOutside()

◆ IsSortable()

◆ MakeCopy()

◆ MakeCopyAt()

◆ MakeInstance()

◆ MakeInstanceAt()

◆ operator!=()

◆ operator<()

◆ operator<=()

◆ operator=()

◆ operator==()

◆ operator>()

◆ operator>=()

◆ Print()

◆ ReleaseInstance()

◆ SizeOf() [1/2]

◆ SizeOf() [2/2]

◆ SizeOfInstance()

◆ Sort()

◆ UpdateArray()

◆ UpdateNavigator()

Member Data Documentation

◆ fArray

◆ fLevel

◆ fMatrix

◆ fMaxLevel

◆ fRealArray