MOOCHO (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Protected Attributes | Private Types | Private Member Functions | List of all members
IterationPack::CastIQMemberBase Class Reference

Base class for some of the implementation features of CastIQMember. More...

#include <IterationPack_CastIQMember.hpp>

Inheritance diagram for IterationPack::CastIQMemberBase:
Inheritance graph
[legend]

Public Member Functions

const std::string & iq_name () const
 Name returns the name of the iteration quantity. More...
 
bool exists_in (const AlgorithmState &s) const
 Returns if the iteration quantity exists in the state object. More...
 

Protected Member Functions

 CastIQMemberBase (const std::string iq_name)
 
void cache_iq_id (const AlgorithmState &s) const
 
void throw_cast_error (const AlgorithmState::iq_id_type iq_id, const std::string &iqa_name) const
 

Protected Attributes

const std::string iq_name_
 
AlgorithmState::iq_id_type iq_id_
 

Private Types

enum  { NOT_SET_YET = AlgorithmState::DOES_NOT_EXIST - 1 }
 

Private Member Functions

 CastIQMemberBase ()
 

Detailed Description

Base class for some of the implementation features of CastIQMember.

This class is included to avoid code blot with the templates.

Definition at line 58 of file IterationPack_CastIQMember.hpp.

Member Enumeration Documentation

anonymous enum
private
Enumerator
NOT_SET_YET 

Definition at line 78 of file IterationPack_CastIQMember.hpp.

Constructor & Destructor Documentation

IterationPack::CastIQMemberBase::CastIQMemberBase ( const std::string  iq_name)
protected

Definition at line 50 of file IterationPack_CastIQMember.cpp.

IterationPack::CastIQMemberBase::CastIQMemberBase ( )
private

Member Function Documentation

const std::string & IterationPack::CastIQMemberBase::iq_name ( ) const

Name returns the name of the iteration quantity.

Definition at line 55 of file IterationPack_CastIQMember.cpp.

bool IterationPack::CastIQMemberBase::exists_in ( const AlgorithmState s) const

Returns if the iteration quantity exists in the state object.

Definition at line 61 of file IterationPack_CastIQMember.cpp.

void IterationPack::CastIQMemberBase::cache_iq_id ( const AlgorithmState s) const
protected

Definition at line 67 of file IterationPack_CastIQMember.cpp.

void IterationPack::CastIQMemberBase::throw_cast_error ( const AlgorithmState::iq_id_type  iq_id,
const std::string &  iqa_name 
) const
protected

Definition at line 74 of file IterationPack_CastIQMember.cpp.

Member Data Documentation

const std::string IterationPack::CastIQMemberBase::iq_name_
protected

Definition at line 74 of file IterationPack_CastIQMember.hpp.

AlgorithmState::iq_id_type IterationPack::CastIQMemberBase::iq_id_
mutableprotected

Definition at line 76 of file IterationPack_CastIQMember.hpp.


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