CASM
AClustersApproachtoStatisticalMechanics
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules
Public Types | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
CASM::ValEnumerator< ValueType, IsConst > Class Template Referenceabstract
Container » Enumerator

#include <Enumerator.hh>

+ Inheritance diagram for CASM::ValEnumerator< ValueType, IsConst >:

Detailed Description

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

Definition at line 86 of file Enumerator.hh.

Public Types

typedef ValueType value_type
 
typedef CASM_TMP::ConstSwitch
< IsConst, ValueType > & 		reference
 
typedef long step_type
 

Public Member Functions

 ValEnumerator ()
 
virtual ~ValEnumerator ()
 
reference current () const
 Access the current ObjectType by reference. More...
 
step_type step () const
 Increments with each enumerated object. More...
 
bool valid () const
 Returns false if enumeration is complete. More...
 
virtual jsonParser source (step_type step) const
 
virtual std::string name () const =0
 Derived enumerators must implement name, via ENUM_MEMBERS. More...
 

Protected Member Functions

void _initialize (value_type *_initial)
 
void _set_current_ptr (value_type *_new)
 Change the pointer. More...
 
value_type & _current ()
 Access the current ObjectType by reference. More...
 
void _initialize ()
 
void _set_step (step_type val)
 Set current step value. More...
 
void _increment_step ()
 Increment current step value. More...
 
void _decrement_step ()
 Decrement current step value. More...
 
void _invalidate ()
 Call if enumeration complete. More...
 
void _validate ()
 Used if random access enumerator step is moved into valid range. More...
 

Private Attributes

value_type * m_current_ptr
 

Member Typedef Documentation

template<typename ValueType, bool IsConst = true>
typedef CASM_TMP::ConstSwitch<IsConst, ValueType>& CASM::ValEnumerator< ValueType, IsConst >::reference

Definition at line 192 of file Enumerator.hh.

template<typename ValueType, bool IsConst = true>
typedef long CASM::EnumeratorBase::step_type

Definition at line 103 of file Enumerator.hh.

template<typename ValueType, bool IsConst = true>
typedef ValueType CASM::ValEnumerator< ValueType, IsConst >::value_type

Definition at line 191 of file Enumerator.hh.

Constructor & Destructor Documentation

template<typename ValueType, bool IsConst = true>
CASM::ValEnumerator< ValueType, IsConst >::ValEnumerator ( )
inline

Definition at line 195 of file Enumerator.hh.

template<typename ValueType, bool IsConst = true>
virtual CASM::ValEnumerator< ValueType, IsConst >::~ValEnumerator ( )
inlinevirtual

Definition at line 198 of file Enumerator.hh.

Member Function Documentation

template<typename ValueType, bool IsConst = true>
value_type& CASM::ValEnumerator< ValueType, IsConst >::_current ( )
inlineprotected

Access the current ObjectType by reference.

Definition at line 244 of file Enumerator.hh.

void CASM::EnumeratorBase::_decrement_step ( )
inlineprotectedinherited

Decrement current step value.

Definition at line 164 of file Enumerator.hh.

void CASM::EnumeratorBase::_increment_step ( )
inlineprotectedinherited

Increment current step value.

Definition at line 159 of file Enumerator.hh.

void CASM::EnumeratorBase::_initialize ( )
inlineprotectedinherited

Initialize

  • Sets step to 0
  • Sets valid to true

Definition at line 148 of file Enumerator.hh.

template<typename ValueType, bool IsConst = true>
void CASM::ValEnumerator< ValueType, IsConst >::_initialize ( value_type *  _initial)
inlineprotected

Initialize

  • Sets current to point at _initial
  • Sets step to 0
  • Sets valid to true

Definition at line 216 of file Enumerator.hh.

void CASM::EnumeratorBase::_invalidate ( )
inlineprotectedinherited

Call if enumeration complete.

Definition at line 169 of file Enumerator.hh.

template<typename ValueType, bool IsConst = true>
void CASM::ValEnumerator< ValueType, IsConst >::_set_current_ptr ( value_type *  _new)
inlineprotected

Change the pointer.

Definition at line 239 of file Enumerator.hh.

void CASM::EnumeratorBase::_set_step ( step_type  val)
inlineprotectedinherited

Set current step value.

Definition at line 154 of file Enumerator.hh.

void CASM::EnumeratorBase::_validate ( )
inlineprotectedinherited

Used if random access enumerator step is moved into valid range.

Definition at line 174 of file Enumerator.hh.

template<typename ValueType, bool IsConst = true>
reference CASM::ValEnumerator< ValueType, IsConst >::current ( ) const
inline

Access the current ObjectType by reference.

Definition at line 232 of file Enumerator.hh.

virtual std::string CASM::EnumeratorBase::name ( ) const
pure virtualinherited

Derived enumerators must implement name, via ENUM_MEMBERS.

Implemented in CASM::ScelEnumT< IsConst >, CASM::ScelEnumByPropsT< IsConst >, CASM::ScelEnumByNameT< IsConst >, CASM::SuperConfigEnum, CASM::ConfigEnumRandomOccupations, CASM::ConfigEnumEquivalents, CASM::ConfigEnumAllOccupations, CASM::TestEnum, CASM::ConfigEnumStrain, CASM::ScelEnumEquivalents, CASM::ConfigEnumInterpolation, and CASM::LatticeEnumEquivalents.

virtual jsonParser CASM::EnumeratorBase::source ( step_type  step) const
inlinevirtualinherited

Default Object source just uses step#

Returns:

{
"enumerated_by": "<enumerator_type>",
"step": <step #>
}

Definition at line 131 of file Enumerator.hh.

step_type CASM::EnumeratorBase::step ( ) const
inlineinherited

Increments with each enumerated object.

Definition at line 113 of file Enumerator.hh.

bool CASM::EnumeratorBase::valid ( ) const
inlineinherited

Returns false if enumeration is complete.

Definition at line 118 of file Enumerator.hh.

Member Data Documentation

template<typename ValueType, bool IsConst = true>
value_type* CASM::ValEnumerator< ValueType, IsConst >::m_current_ptr
private

Definition at line 250 of file Enumerator.hh.

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