CHSM::machine::const_iterator Class Reference

This is an iterator in "STL style" to iterate over the (direct child) states a machine has. More...

#include <chsm.h>

Public Member Functions
	const_iterator ()
	Construct a const_iterator. More...
const_reference	operator* () const
	Returns a machine::const_reference to the state the iterator is positioned at. More...
const_iterator &	operator++ ()
	Pre-increment the iterator. More...
const_iterator	operator++ (int)
	Post-increment the iterator. More...
const_pointer	operator-> () const
	Returns a machine::const_pointer to the state the iterator is positioned at. More...

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

Detailed Description

This is an iterator in "STL style" to iterate over the (direct child) states a machine has.

Constructor & Destructor Documentation

CHSM::machine::const_iterator::const_iterator ( )

inline

Construct a const_iterator.

Member Function Documentation

const_reference CHSM::machine::const_iterator::operator* ( ) const

inline

Returns a machine::const_reference to the state the iterator is positioned at.

Returns

Returns said reference.

const_iterator& CHSM::machine::const_iterator::operator++ ( )

inline

Pre-increment the iterator.

Returns

Returns the iterator positioned at the next state, if any.

const_iterator CHSM::machine::const_iterator::operator++ ( int  )

inline

Post-increment the iterator.

Returns

Returns a new machine::const_iterator positioned at the state the original iterator was positioned at prior to the increment.

const_pointer CHSM::machine::const_iterator::operator-> ( ) const

inline

Returns a machine::const_pointer to the state the iterator is positioned at.

Returns

Returns said pointer.

Friends And Related Function Documentation

bool operator!= ( const_iterator const &  i, const_iterator const &  j  )

friend

Compare two iterators for inequality.

Parameters

i	The first iterator.
j	The second iterator.

Returns

Returns true only if the two iterators are not positioned at the same state.

bool operator== ( const_iterator const &  i, const_iterator const &  j  )

friend

Compare two iterators for equality.

Parameters

i	The first iterator.
j	The 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:

• chsm.h