#include <Enumerator.hh>

Inheritance diagram for CASM::ValEnumIterator< ValueType, IsConst >:

Detailed Description

template<typename ValueType, bool IsConst = true>
class CASM::ValEnumIterator< ValueType, IsConst >

Definition at line 306 of file Enumerator.hh.

Public Types
typedef ValueType	value_type

typedef ValEnumerator< ValueType, IsConst >::reference	reference

typedef EnumeratorBase::step_type	step_type

Public Member Functions
	ValEnumIterator ()

	ValEnumIterator (ValEnumerator< ValueType, IsConst > &enumerator)

virtual	~ValEnumIterator ()

std::unique_ptr< EnumIteratorBase >	clone () const

virtual bool	is_end () const=0
	Returns true if 'end' iterator. More...

std::string	name () const
	Uses enumerator class 'name' implementation. More...

jsonParser	source () const

virtual step_type	step () const=0

virtual step_type	step () const =0

jsonParser	source () const

std::string	name () const
	Uses enumerator class 'name' implementation. More...

virtual bool	is_end () const =0
	Returns true if 'end' iterator. More...

Protected Member Functions
void	_assert_ptr () const

void	_assert_same_ptr (const EnumIteratorBase &other) const

void	_assert_valid () const

EnumeratorBase *	_enum_ptr ()

EnumeratorBase *	_enum_ptr () const

bool	equal (const EnumIteratorBase &other) const
	boost::iterator_facade implementation More...

void	_assert_same_ptr (const EnumIteratorBase &other) const

void	_assert_ptr () const

void	_assert_valid () const

bool	equal (const EnumIteratorBase &other) const
	boost::iterator_facade implementation More...

EnumeratorBase *	_enum_ptr () const

Private Member Functions
virtual EnumIteratorBase *	_clone () const =0

virtual reference	dereference () const =0

EnumeratorBase &	_enum ()

EnumeratorBase &	_enum () const

Private Attributes
EnumeratorBase *	m_enum_ptr

Member Typedef Documentation

◆ reference

template<typename ValueType , bool IsConst = true>

typedef ValEnumerator<ValueType, IsConst>::reference CASM::ValEnumIterator< ValueType, IsConst >::reference

Definition at line 310 of file Enumerator.hh.

◆ step_type

template<typename ValueType , bool IsConst = true>

typedef EnumeratorBase::step_type CASM::EnumIteratorBase::step_type

Definition at line 225 of file Enumerator.hh.

◆ value_type

template<typename ValueType , bool IsConst = true>

typedef ValueType CASM::ValEnumIterator< ValueType, IsConst >::value_type

Definition at line 309 of file Enumerator.hh.

Constructor & Destructor Documentation

◆ ValEnumIterator() [1/2]

template<typename ValueType , bool IsConst = true>

CASM::ValEnumIterator< ValueType, IsConst >::ValEnumIterator ( )

inline

Definition at line 312 of file Enumerator.hh.

◆ ValEnumIterator() [2/2]

template<typename ValueType , bool IsConst = true>

CASM::ValEnumIterator< ValueType, IsConst >::ValEnumIterator ( ValEnumerator< ValueType, IsConst > & enumerator )

inline

Definition at line 314 of file Enumerator.hh.

◆ ~ValEnumIterator()

template<typename ValueType , bool IsConst = true>

virtual CASM::ValEnumIterator< ValueType, IsConst >::~ValEnumIterator ( )

inlinevirtual

Definition at line 317 of file Enumerator.hh.

Member Function Documentation

◆ _assert_ptr() [1/2]

void CASM::EnumIteratorBase::_assert_ptr ( ) const

inlineprotectedinherited

Definition at line 262 of file Enumerator.hh.

◆ _assert_ptr() [2/2]

template<typename ValueType , bool IsConst = true>

void CASM::EnumIteratorBase::_assert_ptr

inlineprotected

Definition at line 262 of file Enumerator.hh.

◆ _assert_same_ptr() [1/2]

void CASM::EnumIteratorBase::_assert_same_ptr ( const EnumIteratorBase & other ) const

inlineprotectedinherited

Definition at line 256 of file Enumerator.hh.

◆ _assert_same_ptr() [2/2]

template<typename ValueType , bool IsConst = true>

void CASM::EnumIteratorBase::_assert_same_ptr

inlineprotected

Definition at line 256 of file Enumerator.hh.

◆ _assert_valid() [1/2]

void CASM::EnumIteratorBase::_assert_valid ( ) const

inlineprotectedinherited

Definition at line 266 of file Enumerator.hh.

◆ _assert_valid() [2/2]

template<typename ValueType , bool IsConst = true>

void CASM::EnumIteratorBase::_assert_valid

inlineprotected

Definition at line 266 of file Enumerator.hh.

◆ _clone()

template<typename ValueType , bool IsConst = true>

virtual EnumIteratorBase* CASM::ValEnumIterator< ValueType, IsConst >::_clone ( ) const

privatepure virtual

Implements CASM::EnumIteratorBase.

Implemented in CASM::RandomAccessEnumIteratorBase< ValueType, IsConst >, CASM::InputEnumIteratorBase< ValueType, IsConst >, and CASM::InputEnumIteratorBase< ValueType, true >.

◆ _enum() [1/2]

EnumeratorBase& CASM::EnumIteratorBase::_enum ( )

inlineprivateinherited

Definition at line 297 of file Enumerator.hh.

◆ _enum() [2/2]

EnumeratorBase& CASM::EnumIteratorBase::_enum ( ) const

inlineprivateinherited

Definition at line 299 of file Enumerator.hh.

◆ _enum_ptr() [1/3]

template<typename ValueType , bool IsConst = true>

EnumeratorBase* CASM::EnumIteratorBase::_enum_ptr

inlineprotected

Definition at line 290 of file Enumerator.hh.

◆ _enum_ptr() [2/3]

EnumeratorBase* CASM::EnumIteratorBase::_enum_ptr ( ) const

inlineprotectedinherited

Definition at line 292 of file Enumerator.hh.

◆ _enum_ptr() [3/3]

template<typename ValueType , bool IsConst = true>

EnumeratorBase* CASM::EnumIteratorBase::_enum_ptr

inlineprotected

Definition at line 292 of file Enumerator.hh.

◆ clone()

template<typename ValueType , bool IsConst = true>

std::unique_ptr<EnumIteratorBase> CASM::ValEnumIterator< ValueType, IsConst >::clone ( ) const

inline

Definition at line 324 of file Enumerator.hh.

◆ dereference()

template<typename ValueType , bool IsConst = true>

virtual reference CASM::ValEnumIterator< ValueType, IsConst >::dereference ( ) const

privatepure virtual

Implemented in CASM::RandomAccessEnumIteratorBase< ValueType, IsConst >, CASM::InputEnumIteratorBase< ValueType, IsConst >, and CASM::InputEnumIteratorBase< ValueType, true >.

◆ equal() [1/2]

bool CASM::EnumIteratorBase::equal ( const EnumIteratorBase & other ) const

inlineprotectedinherited

boost::iterator_facade implementation

Uses 'is_end' implementation to check if both iterators are 'end'
If both are not end, then compares iterator 'step'

Definition at line 275 of file Enumerator.hh.

◆ equal() [2/2]

template<typename ValueType , bool IsConst = true>

bool CASM::EnumIteratorBase::equal

inlineprotected

boost::iterator_facade implementation

Uses 'is_end' implementation to check if both iterators are 'end'
If both are not end, then compares iterator 'step'

Definition at line 275 of file Enumerator.hh.

◆ is_end() [1/2]

virtual bool CASM::EnumIteratorBase::is_end ( ) const

pure virtualinherited

Returns true if 'end' iterator.

Implemented in CASM::RandomAccessEnumIteratorBase< ValueType, IsConst >, CASM::InputEnumIteratorBase< ValueType, IsConst >, and CASM::InputEnumIteratorBase< ValueType, true >.

◆ is_end() [2/2]

template<typename ValueType , bool IsConst = true>

virtual bool CASM::EnumIteratorBase::is_end

Returns true if 'end' iterator.

◆ name() [1/2]

std::string CASM::EnumIteratorBase::name ( ) const

inlineinherited

Uses enumerator class 'name' implementation.

Definition at line 246 of file Enumerator.hh.

◆ name() [2/2]

template<typename ValueType , bool IsConst = true>

std::string CASM::EnumIteratorBase::name

inline

Uses enumerator class 'name' implementation.

Definition at line 246 of file Enumerator.hh.

◆ source() [1/2]

jsonParser CASM::EnumIteratorBase::source ( ) const

inlineinherited

Uses 'step' and enumerator class 'source' implementation

Only valid if iterator refers to valid object (not end)

Definition at line 243 of file Enumerator.hh.

◆ source() [2/2]

template<typename ValueType , bool IsConst = true>

jsonParser CASM::EnumIteratorBase::source

inline

Uses 'step' and enumerator class 'source' implementation

Only valid if iterator refers to valid object (not end)

Definition at line 243 of file Enumerator.hh.

◆ step() [1/2]

virtual step_type CASM::EnumIteratorBase::step ( ) const

pure virtualinherited

Return current step number

Only valid if iterator refers to valid object (not end)

Implemented in CASM::RandomAccessEnumIteratorBase< ValueType, IsConst >, CASM::InputEnumIteratorBase< ValueType, IsConst >, and CASM::InputEnumIteratorBase< ValueType, true >.

◆ step() [2/2]

template<typename ValueType , bool IsConst = true>

virtual step_type CASM::EnumIteratorBase::step

Return current step number

Only valid if iterator refers to valid object (not end)

Member Data Documentation

◆ m_enum_ptr

EnumeratorBase* CASM::EnumIteratorBase::m_enum_ptr

privateinherited

Definition at line 302 of file Enumerator.hh.

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

/Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/include/casm/enumerator/Enumerator.hh

Detailed Description

template<typename ValueType, bool IsConst = true> class CASM::ValEnumIterator< ValueType, IsConst >

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Member Typedef Documentation

◆ reference

◆ step_type

◆ value_type

Constructor & Destructor Documentation

◆ ValEnumIterator() [1/2]

◆ ValEnumIterator() [2/2]

◆ ~ValEnumIterator()

Member Function Documentation

◆ _assert_ptr() [1/2]

◆ _assert_ptr() [2/2]

◆ _assert_same_ptr() [1/2]

◆ _assert_same_ptr() [2/2]

◆ _assert_valid() [1/2]

◆ _assert_valid() [2/2]

◆ _clone()

◆ _enum() [1/2]

◆ _enum() [2/2]

◆ _enum_ptr() [1/3]

◆ _enum_ptr() [2/3]

◆ _enum_ptr() [3/3]

◆ clone()

◆ dereference()

◆ equal() [1/2]

◆ equal() [2/2]

◆ is_end() [1/2]

◆ is_end() [2/2]

◆ name() [1/2]

◆ name() [2/2]

◆ source() [1/2]

◆ source() [2/2]

◆ step() [1/2]

◆ step() [2/2]

Member Data Documentation

◆ m_enum_ptr

template<typename ValueType, bool IsConst = true>
class CASM::ValEnumIterator< ValueType, IsConst >