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

Inheritance diagram for PHDataNodeIterator:

Collaboration diagram for PHDataNodeIterator:

Public Member Functions
	PHDataNodeIterator (PHCompositeNode *node)
	Constructor. More...

virtual	~PHDataNodeIterator ()
	Destructor. More...

template<class T >
PHIODataNode< T > *	FindIODataNode (PHIODataNode< T > node, const char name)

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

Public Member Functions inherited from PHNodeIterator
	PHNodeIterator (PHCompositeNode *)

virtual	~PHNodeIterator ()

	PHNodeIterator ()

void	print ()

PHPointerList< PHNode > &	ls ()

PHNode *	findFirst (const std::string &, const std::string &)

PHNode *	findFirst (const std::string &)

PHBoolean	cd (const std::string &pathString="")

PHBoolean	addNode (PHNode *)

void	forEach (PHNodeOperation &)

void	for_each (PHNodeOperation &)

PHCompositeNode *	get_currentNode () const

Additional Inherited Members
Protected Attributes inherited from PHNodeIterator
PHCompositeNode *	currentNode

PHPointerList< PHNode >	subNodeList

Detailed Description

A special PHOOL node iterator that simplifies finding and adding data nodes.

The methods are templated, rather than the class, to allow the same iterator object to be used with different data node types.

Author: Kyle Pope

Definition at line 19 of file PHDataNodeIterator.h.

Constructor & Destructor Documentation

◆ PHDataNodeIterator()

PHDataNodeIterator::PHDataNodeIterator ( PHCompositeNode * node )

inline

Constructor.

Definition at line 53 of file PHDataNodeIterator.h.

◆ ~PHDataNodeIterator()

virtual PHDataNodeIterator::~PHDataNodeIterator ( )

inlinevirtual

Destructor.

Definition at line 27 of file PHDataNodeIterator.h.

Member Function Documentation

◆ AddIODataNode()

template<class T >

PHBoolean PHDataNodeIterator::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 82 of file PHDataNodeIterator.h.

References PHNodeIterator::addNode(), and False.

Here is the call graph for this function:

◆ FindIODataNode()

template<class T >

PHIODataNode< T > * PHDataNodeIterator::FindIODataNode	(	PHIODataNode< T > *	node,
		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. Note that the return variable is also the first argument; this is necessary to resolve the template type.

Definition at line 61 of file PHDataNodeIterator.h.

References PHNodeIterator::findFirst().