H3D::H3DNodeDatabase::FieldDBConstIterator Class Reference

The FieldDBConstIterator is an iterator class used for iterating over the field instances in an H3DNodeDatabase. More...

#include <H3D/H3DNodeDatabase.h>

Public Member Functions
	FieldDBConstIterator (H3DNodeDatabase *_ndb, bool is_end)
	Constructor.
	FieldDBConstIterator (const FieldDBConstIterator &f)
	Copy constructor.
FieldDBConstIterator &	operator= (const FieldDBConstIterator &rhs)
	Assignment operator.
FieldDBConstIterator &	operator++ (int)
	Pre-increment operator.
FieldDBConstIterator &	operator++ ()
	Post-increment operator.
bool	operator== (FieldDBConstIterator iter)
	Equals operator.
bool	operator!= (FieldDBConstIterator iter)
	Not equals operator.
string	operator* ()
	Dereference operator. More...
FieldDBElement *	getFieldDBElement ()
	Get the FieldDBElement associated with the iterator. More...
Field *	getField (Node *n)
	Get the Field * associated with the iterator. More...

Protected Types
enum	Status { LOCAL , INHERITED , END }
	Defines the status of the iterator. More...

Protected Attributes
Status	status
	The status of the iterator. More...
FieldDBType::const_iterator	local_iterator
	Iterator used for iterating through the local fields in the H3DNodeDatabase.Only valid if status == LOCAL.
H3DUniquePtr< FieldDBConstIterator >	inherited_iterator
	Iterator used for iterating through the fields inherited from the parent database if it exists. More...
H3DNodeDatabase *	ndb
	The database which fields this iterator iterates through.

Detailed Description

The FieldDBConstIterator is an iterator class used for iterating over the field instances in an H3DNodeDatabase.

Dereferensing the iterator will give the name of the field as a string.

Member Enumeration Documentation

Status

enum H3D::H3DNodeDatabase::FieldDBConstIterator::Status

protected

Defines the status of the iterator.

Enumerator
LOCAL	The iterator is currently iterating through the local field definitions.
INHERITED	The iterator is currently iterating through the field definitions of the inherited database fields.
END	The iterator is at end.

Member Function Documentation

getField()

Field* H3D::H3DNodeDatabase::FieldDBConstIterator::getField ( Node *  n )

inline

Get the Field * associated with the iterator.

status == LOCAL )

getFieldDBElement()

FieldDBElement* H3D::H3DNodeDatabase::FieldDBConstIterator::getFieldDBElement ( )

inline

Get the FieldDBElement associated with the iterator.

status == LOCAL )

operator*()

string H3D::H3DNodeDatabase::FieldDBConstIterator::operator* ( )

inline

Dereference operator.

status == LOCAL )

Member Data Documentation

inherited_iterator

H3DUniquePtr< FieldDBConstIterator > H3D::H3DNodeDatabase::FieldDBConstIterator::inherited_iterator

protected

Iterator used for iterating through the fields inherited from the parent database if it exists.

Only valid if status == INHERITED.

Referenced by FieldDBConstIterator(), operator=(), and operator==().

status

Status H3D::H3DNodeDatabase::FieldDBConstIterator::status

protected

The status of the iterator.

Defines what the iterator is currently pointing at.

Referenced by FieldDBConstIterator(), operator=(), and operator==().

---

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

• H3DNodeDatabase.h
• H3DNodeDatabase.cpp