OpenMS  2.8.0
Classes | Public Member Functions | Protected Attributes | List of all members
Param::ParamIterator Class Reference

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

#include <OpenMS/DATASTRUCTURES/Param.h>

Collaboration diagram for Param::ParamIterator:
[legend]

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. More...
 
 ParamIterator (const Param::ParamNode &root)
 Constructor for begin iterator. More...
 
 ~ParamIterator ()
 Destructor. More...
 
const Param::ParamEntryoperator* ()
 Dereferencing. More...
 
const Param::ParamEntryoperator-> ()
 Dereferencing. More...
 
ParamIteratoroperator++ ()
 Prefix increment operator. More...
 
ParamIterator operator++ (int)
 Postfix increment operator. More...
 
bool operator== (const ParamIterator &rhs) const
 Equality operator. More...
 
bool operator!= (const ParamIterator &rhs) const
 Equality operator. More...
 
std::string getName () const
 Returns the absolute path of the current element (including all sections) More...
 
const std::vector< TraceInfo > & getTrace () const
 Returns the traceback of the opened and closed sections. More...
 

Protected Attributes

const Param::ParamNoderoot_
 Pointer to the root node. More...
 
int current_
 Index of the current ParamEntry (-1 means invalid) More...
 
std::vector< const Param::ParamNode * > stack_
 Pointers to the ParamNodes we are in. More...
 
std::vector< TraceInfotrace_
 Node traversal data during last ++ operation. More...
 

Detailed Description

Forward const iterator for the Param class.

Constructor & Destructor Documentation

◆ ParamIterator() [1/2]

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

◆ ParamIterator() [2/2]

ParamIterator ( const Param::ParamNode root)

Constructor for begin iterator.

◆ ~ParamIterator()

Destructor.

Member Function Documentation

◆ getName()

std::string getName ( ) const

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

Referenced by DigestionEnzymeDB< DigestionEnzymeType, InstanceType >::readEnzymesFromFile_().

◆ getTrace()

const std::vector<TraceInfo>& getTrace ( ) const

Returns the traceback of the opened and closed sections.

◆ operator!=()

bool operator!= ( const ParamIterator rhs) const

Equality operator.

◆ operator*()

const Param::ParamEntry& operator* ( )

Dereferencing.

◆ operator++() [1/2]

ParamIterator& operator++ ( )

Prefix increment operator.

◆ operator++() [2/2]

ParamIterator operator++ ( int  )

Postfix increment operator.

◆ operator->()

const Param::ParamEntry* operator-> ( )

Dereferencing.

◆ operator==()

bool operator== ( const ParamIterator rhs) const

Equality operator.

Member Data Documentation

◆ current_

int current_
protected

Index of the current ParamEntry (-1 means invalid)

◆ root_

const Param::ParamNode* root_
protected

Pointer to the root node.

◆ stack_

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

Pointers to the ParamNodes we are in.

◆ trace_

std::vector<TraceInfo> trace_
protected

Node traversal data during last ++ operation.