Class Reference for E1039 Core & Analysis Software
PHTypedNodeIterator< T > Class Template Reference

#include </dev/shm/kenichi/update-github-e1039-doc/e1039-core/framework/phool/PHTypedNodeIterator.h>

+ Inheritance diagram for PHTypedNodeIterator< T >:
+ Collaboration diagram for PHTypedNodeIterator< T >:

Public Member Functions

 PHTypedNodeIterator (PHCompositeNode *n)
 Constructor. More...
 
 PHTypedNodeIterator ()
 
T & operator* ()
 
 ~PHTypedNodeIterator ()
 Destructor. More...
 
PHIODataNode< T > * FindIODataNode (const char *name)
 
PHIODataNode< T > * find (const char *name)
 
PHBoolean AddIODataNode (T *data, const char *name)
 
PHBoolean insert (T *data, const char *name)
 
- Public Member Functions inherited from PHNodeIterator
 PHNodeIterator (PHCompositeNode *)
 
virtual ~PHNodeIterator ()
 
 PHNodeIterator ()
 
void print ()
 
PHPointerList< PHNode > & ls ()
 
PHNodefindFirst (const std::string &, const std::string &)
 
PHNodefindFirst (const std::string &)
 
PHBoolean cd (const std::string &pathString="")
 
PHBoolean addNode (PHNode *)
 
void forEach (PHNodeOperation &)
 
void for_each (PHNodeOperation &)
 
PHCompositeNodeget_currentNode () const
 

Protected Attributes

PHIODataNode< T > * myIODataNode
 
- Protected Attributes inherited from PHNodeIterator
PHCompositeNodecurrentNode
 
PHPointerList< PHNodesubNodeList
 

Detailed Description

template<class T>
class PHTypedNodeIterator< T >

Definition at line 19 of file PHTypedNodeIterator.h.

Constructor & Destructor Documentation

◆ PHTypedNodeIterator() [1/2]

template<class T >
PHTypedNodeIterator< T >::PHTypedNodeIterator ( PHCompositeNode n)
inline

Constructor.

Definition at line 24 of file PHTypedNodeIterator.h.

References PHTypedNodeIterator< T >::myIODataNode.

◆ PHTypedNodeIterator() [2/2]

template<class T >
PHTypedNodeIterator< T >::PHTypedNodeIterator ( )
inline

Definition at line 28 of file PHTypedNodeIterator.h.

References PHTypedNodeIterator< T >::myIODataNode.

◆ ~PHTypedNodeIterator()

template<class T >
PHTypedNodeIterator< T >::~PHTypedNodeIterator ( )
inline

Destructor.

Definition at line 36 of file PHTypedNodeIterator.h.

Member Function Documentation

◆ AddIODataNode()

template<class T >
PHBoolean PHTypedNodeIterator< T >::AddIODataNode ( T *  data,
const char *  name 
)

Adds a data node called "name" to the tree, and inserts "data". The data node is added at the current "directory" of this iterator object, so remember to "cd" to the desired location in the tree!

Definition at line 100 of file PHTypedNodeIterator.h.

◆ find()

template<class T >
PHIODataNode< T > * PHTypedNodeIterator< T >::find ( const char *  name)

Definition at line 79 of file PHTypedNodeIterator.h.

◆ FindIODataNode()

template<class T >
PHIODataNode< T > * PHTypedNodeIterator< T >::FindIODataNode ( const char *  name)

Finds an IODataNode of name "name" containing data of type "T". A null pointer will be returned if the node is not found, or if it contains data of the wrong type.

Definition at line 72 of file PHTypedNodeIterator.h.

◆ insert()

template<class T >
PHBoolean PHTypedNodeIterator< T >::insert ( T *  data,
const char *  name 
)

Definition at line 107 of file PHTypedNodeIterator.h.

References False.

◆ operator*()

template<class T >
T & PHTypedNodeIterator< T >::operator*

Definition at line 65 of file PHTypedNodeIterator.h.

Member Data Documentation

◆ myIODataNode

template<class T >
PHIODataNode<T>* PHTypedNodeIterator< T >::myIODataNode
protected

Definition at line 59 of file PHTypedNodeIterator.h.

Referenced by PHTypedNodeIterator< T >::PHTypedNodeIterator().


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