Open Model Railroad Network (OpenMRN)
Loading...
Searching...
No Matches
SysMap< Key, Value >::Iterator Class Reference

This mimics an std::iterator. More...

#include <SysMap.hxx>

Public Member Functions

 Iterator ()
 Default constructor.
 
 Iterator (const Iterator &it)
 Copy constructor.
 
 Iterator (SysMap *context, Node *node)
 Constructor.
 
 ~Iterator ()
 Destructor.
 
Pairoperator* () const
 Overloaded reference operator.
 
Pairoperator-> () const
 Overloaded pointer operator.
 
Iteratoroperator++ ()
 Overloaded pre-increement operator.
 
bool operator!= (const Iterator &it)
 Overloaded not equals operator.
 
bool operator== (const Iterator &it)
 Overloaded equals operator.
 

Private Attributes

Nodenode
 node this iteration is currently indexed to
 
SysMapm
 Context this iteration lives in.
 

Friends

class SysMap
 Allow access to node member.
 

Detailed Description

template<typename Key, typename Value>
class SysMap< Key, Value >::Iterator

This mimics an std::iterator.

Definition at line 114 of file SysMap.hxx.

Constructor & Destructor Documentation

◆ Iterator() [1/3]

template<typename Key , typename Value >
SysMap< Key, Value >::Iterator::Iterator ( )
inline

Default constructor.

Definition at line 119 of file SysMap.hxx.

◆ Iterator() [2/3]

template<typename Key , typename Value >
SysMap< Key, Value >::Iterator::Iterator ( const Iterator it)
inline

Copy constructor.

Definition at line 127 of file SysMap.hxx.

◆ Iterator() [3/3]

template<typename Key , typename Value >
SysMap< Key, Value >::Iterator::Iterator ( SysMap context,
Node node 
)
inline

Constructor.

Parameters
contextcontext passed in at instantiation
nodenode to initialize this iteration with

Definition at line 137 of file SysMap.hxx.

◆ ~Iterator()

template<typename Key , typename Value >
SysMap< Key, Value >::Iterator::~Iterator ( )
inline

Destructor.

Definition at line 145 of file SysMap.hxx.

Member Function Documentation

◆ operator!=()

template<typename Key , typename Value >
bool SysMap< Key, Value >::Iterator::operator!= ( const Iterator it)
inline

Overloaded not equals operator.

Definition at line 174 of file SysMap.hxx.

◆ operator*()

template<typename Key , typename Value >
Pair & SysMap< Key, Value >::Iterator::operator* ( ) const
inline

Overloaded reference operator.

Definition at line 151 of file SysMap.hxx.

◆ operator++()

template<typename Key , typename Value >
Iterator & SysMap< Key, Value >::Iterator::operator++ ( )
inline

Overloaded pre-increement operator.

Definition at line 164 of file SysMap.hxx.

◆ operator->()

template<typename Key , typename Value >
Pair * SysMap< Key, Value >::Iterator::operator-> ( ) const
inline

Overloaded pointer operator.

Definition at line 158 of file SysMap.hxx.

◆ operator==()

template<typename Key , typename Value >
bool SysMap< Key, Value >::Iterator::operator== ( const Iterator it)
inline

Overloaded equals operator.

Definition at line 180 of file SysMap.hxx.

Friends And Related Symbol Documentation

◆ SysMap

template<typename Key , typename Value >
friend class SysMap
friend

Allow access to node member.

Definition at line 193 of file SysMap.hxx.

Member Data Documentation

◆ m

template<typename Key , typename Value >
SysMap* SysMap< Key, Value >::Iterator::m
private

Context this iteration lives in.

Definition at line 190 of file SysMap.hxx.

◆ node

template<typename Key , typename Value >
Node* SysMap< Key, Value >::Iterator::node
private

node this iteration is currently indexed to

Definition at line 187 of file SysMap.hxx.


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