Tapkee
Parameter Class Reference

#include <parameters.hpp>

List of all members.

Public Member Functions

 Parameter ()
 Parameter (const Parameter &p)
 ~Parameter ()
template<typename T >
Parameter withDefault (T value)
template<typename T >
 operator T ()
 operator ParametersSet ()
template<typename T >
bool is (T v)
template<typename T >
bool operator== (T v) const
CheckedParameter checked ()
template<typename T >
bool isInRange (T lower, T upper) const
template<typename T >
bool isEqual (T value) const
template<typename T >
bool isNotEqual (T value) const
bool isPositive () const
bool isNonNegative () const
bool isNegative () const
template<typename T >
bool isGreater (T lower) const
template<typename T >
bool isLesser (T upper) const
bool isInitialized () const
ParameterName name () const
ParametersSet operator, (const Parameter &p)

Static Public Member Functions

template<typename T >
static Parameter create (const std::string &name, const T &value)

Private Types

typedef std::string ParameterName

Private Member Functions

template<typename T >
 Parameter (const ParameterName &pname, const T &value)
template<typename T >
getValue () const
template<typename T >
bool isTypeCorrect () const
void invalidate (const std::string &reason)

Private Attributes

bool valid
std::string invalidity_reason
ParameterName parameter_name
tapkee_internal::ValueKeeper keeper

Friends

class CheckedParameter

Detailed Description

Definition at line 42 of file parameters.hpp.


Member Typedef Documentation

typedef std::string ParameterName [private]

Definition at line 46 of file parameters.hpp.


Constructor & Destructor Documentation

Parameter ( const ParameterName pname,
const T &  value 
) [private]

Definition at line 51 of file parameters.hpp.

Parameter ( )

Definition at line 65 of file parameters.hpp.

Parameter ( const Parameter p)

Definition at line 71 of file parameters.hpp.

~Parameter ( )

Definition at line 77 of file parameters.hpp.


Member Function Documentation

Definition at line 300 of file parameters.hpp.

static Parameter create ( const std::string &  name,
const T &  value 
) [static]

Definition at line 60 of file parameters.hpp.

T getValue ( ) const [private]

Definition at line 189 of file parameters.hpp.

void invalidate ( const std::string &  reason) [private]

Definition at line 200 of file parameters.hpp.

bool is ( v)

Definition at line 111 of file parameters.hpp.

bool isEqual ( value) const

Definition at line 136 of file parameters.hpp.

bool isGreater ( lower) const

Definition at line 163 of file parameters.hpp.

bool isInitialized ( ) const

Definition at line 174 of file parameters.hpp.

bool isInRange ( lower,
upper 
) const

Definition at line 130 of file parameters.hpp.

bool isLesser ( upper) const

Definition at line 169 of file parameters.hpp.

bool isNegative ( ) const

Definition at line 157 of file parameters.hpp.

bool isNonNegative ( ) const

Definition at line 152 of file parameters.hpp.

bool isNotEqual ( value) const

Definition at line 142 of file parameters.hpp.

bool isPositive ( ) const

Definition at line 147 of file parameters.hpp.

bool isTypeCorrect ( ) const [private]

Definition at line 195 of file parameters.hpp.

ParameterName name ( ) const

Definition at line 179 of file parameters.hpp.

operator ParametersSet ( )

Definition at line 367 of file parameters.hpp.

operator T ( )

Definition at line 92 of file parameters.hpp.

ParametersSet operator, ( const Parameter p)

Definition at line 359 of file parameters.hpp.

bool operator== ( v) const

Definition at line 122 of file parameters.hpp.

Parameter withDefault ( value)

Definition at line 82 of file parameters.hpp.


Friends And Related Function Documentation

friend class CheckedParameter [friend]

Definition at line 44 of file parameters.hpp.


Member Data Documentation

std::string invalidity_reason [private]

Definition at line 209 of file parameters.hpp.

Definition at line 213 of file parameters.hpp.

Definition at line 211 of file parameters.hpp.

bool valid [private]

Definition at line 208 of file parameters.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines