CHSM  4.4.1
Public Member Functions | Friends | List of all members
CHSM::parent::iterator Class Reference

This is an iterator in "STL style" to iterate over the child states of a parent state. More...

#include <chsm.h>

Public Member Functions

 iterator ()
 Construct an iterator. More...
 
reference operator* () const
 Returns a parent::reference to the state the iterator is positioned at. More...
 
iteratoroperator++ ()
 Pre-increment the iterator. More...
 
iterator operator++ (int)
 Post-increment the iterator. More...
 
pointer operator-> () const
 Returns a parent::pointer to the state the iterator is positioned at. More...
 

Friends

bool operator!= (iterator const &i, iterator const &j)
 Compare two iterators for inequality. More...
 
bool operator== (iterator const &i, iterator const &j)
 Compare two iterators for equality. More...
 

Detailed Description

This is an iterator in "STL style" to iterate over the child states of a parent state.

Constructor & Destructor Documentation

CHSM::parent::iterator::iterator ( )
inline

Construct an iterator.

Member Function Documentation

reference CHSM::parent::iterator::operator* ( ) const
inline

Returns a parent::reference to the state the iterator is positioned at.

Returns
Returns said reference.
iterator& CHSM::parent::iterator::operator++ ( )
inline

Pre-increment the iterator.

Returns
Returns the iterator positioned at the next state, if any.
iterator CHSM::parent::iterator::operator++ ( int  )
inline

Post-increment the iterator.

Returns
Returns a new iterator positioned at the state the original iterator was positioned at prior to the increment.
pointer CHSM::parent::iterator::operator-> ( ) const
inline

Returns a parent::pointer to the state the iterator is positioned at.

Returns
Returns said pointer.

Friends And Related Function Documentation

bool operator!= ( iterator const &  i,
iterator const &  j 
)
friend

Compare two iterators for inequality.

Parameters
iThe first iterator.
jThe second iterator.
Returns
Returns true only if the two iterators are not positioned at the same state.
bool operator== ( iterator const &  i,
iterator const &  j 
)
friend

Compare two iterators for equality.

Parameters
iThe first iterator.
jThe second iterator.
Returns
Returns true only if the two iterators are positioned at the same state.

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