COPASI API  4.40.278
CCopasiTree< _Node >::iterator Class Reference

#include <CCopasiTree.h>

Inheritance diagram for CCopasiTree< _Node >::iterator:
[legend]

Public Member Functions

 iterator (_Node *begin=NULL)
 
 iterator (const iterator &src)
 
bool operator!= (const iterator &rhs)
 
_Node & operator* () const
 
iteratoroperator++ ()
 
_Node * operator-> () const
 
iteratoroperator= (_Node *pNode)
 
 ~iterator ()
 

Private Attributes

_Node * mCurrent
 

Detailed Description

template<class _Node>
class CCopasiTree< _Node >::iterator

A forward iterator used to traverse the tree.

Constructor & Destructor Documentation

◆ iterator() [1/2]

template<class _Node >
CCopasiTree< _Node >::iterator::iterator ( _Node *  begin = NULL)
inline

Default constructor. Note: When no argument is given the iterator points to the end of the tree.

Parameters
Node* begin (default NULL)

◆ iterator() [2/2]

template<class _Node >
CCopasiTree< _Node >::iterator::iterator ( const iterator src)
inline

Copy constructor

Parameters
constiterator & src

◆ ~iterator()

template<class _Node >
CCopasiTree< _Node >::iterator::~iterator ( )
inline

Destructor

Member Function Documentation

◆ operator!=()

template<class _Node >
bool CCopasiTree< _Node >::iterator::operator!= ( const iterator rhs)
inline

Comparison operator !=

Parameters
constiterator &rhs
Returns
bool not-equal

References CCopasiTree< _Node >::iterator::mCurrent.

◆ operator*()

template<class _Node >
_Node& CCopasiTree< _Node >::iterator::operator* ( ) const
inline

Dereference operator * returns the node the iterator points to.

Returns
Node &

References CCopasiTree< _Node >::iterator::mCurrent.

◆ operator++()

template<class _Node >
iterator& CCopasiTree< _Node >::iterator::operator++ ( )
inline

Prefix increment operator ++

Returns
iterator &

References CCopasiTree< _Node >::iterator::mCurrent.

◆ operator->()

template<class _Node >
_Node* CCopasiTree< _Node >::iterator::operator-> ( ) const
inline

Dereference operator * returns the node the iterator points to.

Returns
Node &

References CCopasiTree< _Node >::iterator::mCurrent.

◆ operator=()

template<class _Node >
iterator& CCopasiTree< _Node >::iterator::operator= ( _Node *  pNode)
inline

Assignment operator from a node to an iterator

Parameters
Node* pNode
Returns
iterator &

References CCopasiTree< _Node >::iterator::mCurrent.

Member Data Documentation

◆ mCurrent


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