Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages

Param::ParamIterator Class Reference

#include <OpenMS/DATASTRUCTURES/Param.h>

List of all members.


Detailed Description

Forward const iterator for the Param class.

Public Member Functions

 ParamIterator ()
 Default constructor used to create a past-the-end iterator.
 ParamIterator (const Param::ParamNode &root)
 Constructor for begin iterator.
const Param::ParamEntryoperator * ()
 Dereferencing.
const Param::ParamEntryoperator-> ()
 Dereferencing.
ParamIteratoroperator++ ()
 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::ParamNoderoot_
 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< TraceInfotrace_
 Node traversal data during last ++ operation.

Classes

struct  TraceInfo
 Struct that captures information on entered / left nodes for ParamIterator. More...

Constructor & Destructor Documentation

ParamIterator (  ) 

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

ParamIterator ( const Param::ParamNode root  ) 

Constructor for begin iterator.


Member Function Documentation

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.


Member Data Documentation

const Param::ParamNode* root_ [protected]

Pointer to the root node.

Int current_ [protected]

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

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.


The documentation for this class was generated from the following file:
Generated Tue Apr 1 15:36:43 2008 -- using doxygen 1.5.4 OpenMS / TOPP 1.1