Logo ROOT  

Reference Guide
Loading...
Searching...
No Matches
TGeoIterator Class Reference
Geometry » Geometry classes

A geometry iterator.

A geometry iterator that sequentially follows all nodes of the geometrical hierarchy of a volume. The iterator has to be initiated with a top volume pointer:

TGeoIterator next(myVolume);

One can use the iterator as any other in ROOT:

TGeoNode *node;
while ((node=next())) {
...
}
TGeoNode
A node represent a volume positioned inside another.They store links to both volumes and to the TGeoM...
Definition TGeoNode.h:39

The iterator can perform 2 types of iterations that can be selected via:

next.SetType(Int_t type);
Int_t
int Int_t
Signed integer 4 bytes (int).
Definition RtypesCore.h:59

Here TYPE can be:

  • 0 (default) - 'first daughter next' behavior
  • 1 - iteration at the current level only

Supposing the tree structure looks like:

TOP ___ A_1 ___ A1_1 ___ A11_1
| | |___ A12_1
| |_____A2_1 ___ A21_1
| |___ A21_2
|___ B_1 ...

The order of iteration for TYPE=0 is: A_1, A1_1, A11_1, A12_1, A2_1, A21_1, A21_2, B_1, ...

The order of iteration for TYPE=1 is: A_1, B_1, ... At any moment during iteration, TYPE can be changed. If the last iterated node is for instance A1_1 and the iteration type was 0, one can do:

next.SetType(1);

The next iterated nodes will be the rest of A daughters: A2,A3,... The iterator will return 0 after finishing all daughters of A.

During iteration, the following can be retrieved:

  • Top volume where iteration started: TGeoIterator::GetTopVolume()
  • Node at level I in the current branch: TGeoIterator::GetNode(Int_t i)
  • Iteration type: TGeoIterator::GetType()
  • Global matrix of the current node with respect to the top volume: TGeoIterator::GetCurrentMatrix()

The iterator can be reset by changing (or not) the top volume:

TGeoIterator::Reset(TGeoVolume *top);
TGeoIterator::Reset
void Reset(TGeoVolume *top=nullptr)
Resets the iterator for volume TOP.
Definition TGeoNode.cxx:1343
TGeoVolume
TGeoVolume, TGeoVolumeMulti, TGeoVolumeAssembly are the volume classes.
Definition TGeoVolume.h:43

Example:

We want to find out a volume named "MyVol" in the hierarchy of TOP volume.

TIter next(TOP);
TGeoNode *node;
TString name("MyVol");
while ((node=next()))
if (name == node->GetVolume()->GetName()) return node->GetVolume();
name
char name[80]
Definition TGX11.cxx:148
TGeoNode::GetVolume
TGeoVolume * GetVolume() const
Definition TGeoNode.h:100
TNamed::GetName
const char * GetName() const override
Returns name of object.
Definition TNamed.h:49
TString
Basic string class.
Definition TString.h:138

Definition at line 249 of file TGeoNode.h.

Public Member Functions

 TGeoIterator (const TGeoIterator &iter)
 Copy ctor.
 TGeoIterator (TGeoVolume *top)
 Geometry iterator for a branch starting with a TOP node.
virtual ~TGeoIterator ()
 Destructor.
const TGeoMatrix * GetCurrentMatrix () const
 Returns global matrix for current node.
Int_t GetIndex (Int_t i) const
Int_t GetLevel () const
TGeoNode * GetNode (Int_t level) const
 Returns current node at a given level.
void GetPath (TString &path) const
 Returns the path for the current node.
TGeoVolume * GetTopVolume () const
Int_t GetType () const
TGeoIteratorPlugin * GetUserPlugin () const
virtual TClass * IsA () const
TGeoNode * Next ()
 Returns next node.
TGeoNode * operator() ()
 Returns next node.
TGeoIterator & operator= (const TGeoIterator &iter)
 Assignment.
void Reset (TGeoVolume *top=nullptr)
 Resets the iterator for volume TOP.
void SetPluginAutoexec (Bool_t mode)
void SetTopName (const char *name)
 Set the top name for path.
void SetType (Int_t type)
void SetUserPlugin (TGeoIteratorPlugin *plugin)
 Set a plugin.
void Skip ()
 Stop iterating the current branch.
virtual void Streamer (TBuffer &)
void StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
void Up ()

Static Public Member Functions

static TClass * Class ()
static const char * Class_Name ()
static constexpr Version_t Class_Version ()
static const char * DeclFileName ()

Protected Member Functions

 TGeoIterator ()

Private Member Functions

void IncreaseArray ()
 Increase by 30 the size of the array.

Private Attributes

Int_t * fArray = nullptr
Int_t fLevel = 0
TGeoHMatrix * fMatrix = nullptr
Bool_t fMustResume = kFALSE
Bool_t fMustStop = kFALSE
TGeoIteratorPlugin * fPlugin = nullptr
Bool_t fPluginAutoexec = kFALSE
TGeoVolume * fTop = nullptr
TString fTopName
Int_t fType = 0

#include <TGeoNode.h>

Constructor & Destructor Documentation

◆ TGeoIterator() [1/3]

TGeoIterator::TGeoIterator ( )
inlineprotected

Definition at line 265 of file TGeoNode.h.

◆ TGeoIterator() [2/3]

TGeoIterator::TGeoIterator ( TGeoVolume * top)

Geometry iterator for a branch starting with a TOP node.

Definition at line 1112 of file TGeoNode.cxx.

◆ TGeoIterator() [3/3]

TGeoIterator::TGeoIterator ( const TGeoIterator & iter)

Copy ctor.

Definition at line 1129 of file TGeoNode.cxx.

◆ ~TGeoIterator()

TGeoIterator::~TGeoIterator ( )
virtual

Destructor.

Definition at line 1149 of file TGeoNode.cxx.

Member Function Documentation

◆ Class()

TClass * TGeoIterator::Class ( )
static
Returns
TClass describing this class

◆ Class_Name()

const char * TGeoIterator::Class_Name ( )
static
Returns
Name of this class

◆ Class_Version()

constexpr Version_t TGeoIterator::Class_Version ( )
inlinestaticconstexpr
Returns
Version of this class

Definition at line 309 of file TGeoNode.h.

◆ DeclFileName()

const char * TGeoIterator::DeclFileName ( )
inlinestatic
Returns
Name of the file containing the class declaration

Definition at line 309 of file TGeoNode.h.

◆ GetCurrentMatrix()

const TGeoMatrix * TGeoIterator::GetCurrentMatrix ( ) const

Returns global matrix for current node.

Definition at line 1284 of file TGeoNode.cxx.

◆ GetIndex()

Int_t TGeoIterator::GetIndex ( Int_t i) const
inline

Definition at line 294 of file TGeoNode.h.

◆ GetLevel()

Int_t TGeoIterator::GetLevel ( ) const
inline

Definition at line 295 of file TGeoNode.h.

◆ GetNode()

TGeoNode * TGeoIterator::GetNode ( Int_t level) const

Returns current node at a given level.

Definition at line 1301 of file TGeoNode.cxx.

◆ GetPath()

void TGeoIterator::GetPath ( TString & path) const

Returns the path for the current node.

Definition at line 1314 of file TGeoNode.cxx.

◆ GetTopVolume()

TGeoVolume * TGeoIterator::GetTopVolume ( ) const
inline

Definition at line 300 of file TGeoNode.h.

◆ GetType()

Int_t TGeoIterator::GetType ( ) const
inline

Definition at line 301 of file TGeoNode.h.

◆ GetUserPlugin()

TGeoIteratorPlugin * TGeoIterator::GetUserPlugin ( ) const
inline

Definition at line 298 of file TGeoNode.h.

◆ IncreaseArray()

void TGeoIterator::IncreaseArray ( )
private

Increase by 30 the size of the array.

Definition at line 1332 of file TGeoNode.cxx.

◆ IsA()

virtual TClass * TGeoIterator::IsA ( ) const
inlinevirtual
Returns
TClass describing current object

Definition at line 309 of file TGeoNode.h.

◆ Next()

TGeoNode * TGeoIterator::Next ( )

Returns next node.

Definition at line 1186 of file TGeoNode.cxx.

◆ operator()()

TGeoNode * TGeoIterator::operator() ( )

Returns next node.

Definition at line 1276 of file TGeoNode.cxx.

◆ operator=()

TGeoIterator & TGeoIterator::operator= ( const TGeoIterator & iter)

Assignment.

Definition at line 1159 of file TGeoNode.cxx.

◆ Reset()

void TGeoIterator::Reset ( TGeoVolume * top = nullptr)

Resets the iterator for volume TOP.

Definition at line 1343 of file TGeoNode.cxx.

◆ SetPluginAutoexec()

void TGeoIterator::SetPluginAutoexec ( Bool_t mode)
inline

Definition at line 304 of file TGeoNode.h.

◆ SetTopName()

void TGeoIterator::SetTopName ( const char * name)

Set the top name for path.

Definition at line 1355 of file TGeoNode.cxx.

◆ SetType()

void TGeoIterator::SetType ( Int_t type)
inline

Definition at line 305 of file TGeoNode.h.

◆ SetUserPlugin()

void TGeoIterator::SetUserPlugin ( TGeoIteratorPlugin * plugin)

Set a plugin.

Definition at line 1403 of file TGeoNode.cxx.

◆ Skip()

void TGeoIterator::Skip ( )

Stop iterating the current branch.

The iteration of the next node will behave as if the branch starting from the current node (included) is not existing.

Definition at line 1364 of file TGeoNode.cxx.

◆ Streamer()

virtual void TGeoIterator::Streamer ( TBuffer & )
virtual

◆ StreamerNVirtual()

void TGeoIterator::StreamerNVirtual ( TBuffer & ClassDef_StreamerNVirtual_b)
inline

Definition at line 309 of file TGeoNode.h.

◆ Up()

void TGeoIterator::Up ( )
inline

Definition at line 287 of file TGeoNode.h.

Member Data Documentation

◆ fArray

Int_t* TGeoIterator::fArray = nullptr
private

Definition at line 256 of file TGeoNode.h.

◆ fLevel

Int_t TGeoIterator::fLevel = 0
private

Definition at line 254 of file TGeoNode.h.

◆ fMatrix

TGeoHMatrix* TGeoIterator::fMatrix = nullptr
private

Definition at line 257 of file TGeoNode.h.

◆ fMustResume

Bool_t TGeoIterator::fMustResume = kFALSE
private

Definition at line 252 of file TGeoNode.h.

◆ fMustStop

Bool_t TGeoIterator::fMustStop = kFALSE
private

Definition at line 253 of file TGeoNode.h.

◆ fPlugin

TGeoIteratorPlugin* TGeoIterator::fPlugin = nullptr
private

Definition at line 259 of file TGeoNode.h.

◆ fPluginAutoexec

Bool_t TGeoIterator::fPluginAutoexec = kFALSE
private

Definition at line 260 of file TGeoNode.h.

◆ fTop

TGeoVolume* TGeoIterator::fTop = nullptr
private

Definition at line 251 of file TGeoNode.h.

◆ fTopName

TString TGeoIterator::fTopName
private

Definition at line 258 of file TGeoNode.h.

◆ fType

Int_t TGeoIterator::fType = 0
private

Definition at line 255 of file TGeoNode.h.

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