Param::ParamIterator Class Reference

Forward const iterator for the Param class. More...

#include <OpenMS/DATASTRUCTURES/Param.h>

List of all members.

Classes
struct	TraceInfo
	Struct that captures information on entered / left nodes for ParamIterator. More...
Public Member Functions
	ParamIterator ()
	Default constructor used to create a past-the-end iterator.
	ParamIterator (const Param::ParamNode &root)
	Constructor for begin iterator.
	~ParamIterator ()
	Destructor.
const Param::ParamEntry &	operator* ()
	Dereferencing.
const Param::ParamEntry *	operator-> ()
	Dereferencing.
ParamIterator &	operator++ ()
	Prefix increment operator.
ParamIterator	operator++ (int)
	Postfix increment operator.
bool	operator== (const ParamIterator &rhs) const
	Equality operator.
bool	operator!= (const ParamIterator &rhs) const
	Equality operator.
String	getName () const
	Returns the absolute path of the current element (including all sections).
const std::vector< TraceInfo > &	getTrace () const
	Returns the traceback of the opened and closed sections.
Protected Attributes
const Param::ParamNode *	root_
	Pointer to the root node.
Int	current_
	Index of the current ParamEntry (-1 means invalid).
std::vector< const Param::ParamNode * >	stack_
	Pointers to the ParmNodes we are in.
std::vector< TraceInfo >	trace_
	Node traversal data during last ++ operation.

---

Detailed Description

Forward const iterator for the Param class.

---

Constructor & Destructor Documentation

ParamIterator

(

)

Default constructor used to create a past-the-end iterator.

ParamIterator

(

const Param::ParamNode &

root

)

Constructor for begin iterator.

~ParamIterator

(

)

Destructor.

---

Member Function Documentation

String getName

(

)

const

Returns the absolute path of the current element (including all sections).

const std::vector<TraceInfo>& getTrace

(

)

const

Returns the traceback of the opened and closed sections.

bool operator!=

(

const ParamIterator &

rhs

)

const

Equality operator.

const Param::ParamEntry& operator*

(

)

Dereferencing.

ParamIterator operator++

(

int

)

Postfix increment operator.

ParamIterator& operator++

(

)

Prefix increment operator.

const Param::ParamEntry* operator->

(

)

Dereferencing.

bool operator==

(

const ParamIterator &

rhs

)

const

Equality operator.

---

Member Data Documentation

Int current_ [protected]

Index of the current ParamEntry (-1 means invalid).

const Param::ParamNode* root_ [protected]

Pointer to the root node.

std::vector<const Param::ParamNode*> stack_ [protected]

Pointers to the ParmNodes we are in.

std::vector<TraceInfo> trace_ [protected]

Node traversal data during last ++ operation.