karto::ParameterEnum Class Reference

#include <Karto.h>

Inheritance diagram for karto::ParameterEnum:

Public Member Functions
virtual Parameter< kt_int32s > *	Clone ()
void	DefineEnumValue (kt_int32s value, const std::string &rName)
virtual const std::string	GetValueAsString () const
ParameterEnum &	operator= (const ParameterEnum &rOther)
kt_int32s	operator= (kt_int32s value)
	ParameterEnum (const std::string &rName, kt_int32s value, ParameterManager *pParameterManger=NULL)
	ParameterEnum ()
virtual void	SetValueFromString (const std::string &rStringValue)
virtual	~ParameterEnum ()
Public Member Functions inherited from karto::Parameter< kt_int32s >
const kt_int32s &	GetValue () const
const std::string	GetValueAsString () const
const std::string	GetValueAsString () const
Parameter &	operator= (const Parameter &rOther)
kt_int32s	operator= (kt_int32s value)
	Parameter ()
	Parameter (const std::string &rName, kt_int32s value, ParameterManager *pParameterManger=NULL)
	Parameter (const std::string &rName, const std::string &rDescription, kt_int32s value, ParameterManager *pParameterManger=NULL)
void	serialize (Archive &ar, const unsigned int version)
void	SetValue (const kt_int32s &rValue)
void	SetValueFromString (const std::string &rStringValue)
void	SetValueFromString (const std::string &rStringValue)
virtual	~Parameter ()
Public Member Functions inherited from karto::AbstractParameter
	AbstractParameter ()
	AbstractParameter (const std::string &rName, ParameterManager *pParameterManger=NULL)
	AbstractParameter (const std::string &rName, const std::string &rDescription, ParameterManager *pParameterManger=NULL)
const std::string &	GetDescription () const
const std::string &	GetName () const
virtual	~AbstractParameter ()

Private Types
typedef std::map< std::string, kt_int32s >	EnumMap

Private Member Functions
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)

Private Attributes
EnumMap	m_EnumDefines

Friends
class	boost::serialization::access

Additional Inherited Members
Protected Attributes inherited from karto::Parameter< kt_int32s >
kt_int32s	m_Value

Detailed Description

Parameter enum class

Definition at line 3409 of file Karto.h.

Member Typedef Documentation

EnumMap

typedef std::map<std::string, kt_int32s> karto::ParameterEnum::EnumMap

private

Definition at line 3411 of file Karto.h.

Constructor & Destructor Documentation

ParameterEnum() [1/2]

karto::ParameterEnum::ParameterEnum ( const std::string &  rName, kt_int32s  value, ParameterManager *  pParameterManger = NULL  )

inline

Construct a Parameter object with name and value

Parameters

rName	parameter name
value	of parameter
pParameterManger

Definition at line 3420 of file Karto.h.

ParameterEnum() [2/2]

karto::ParameterEnum::ParameterEnum ( )

inline

Definition at line 3424 of file Karto.h.

~ParameterEnum()

virtual karto::ParameterEnum::~ParameterEnum ( )

inlinevirtual

Destructor

Definition at line 3431 of file Karto.h.

Member Function Documentation

Clone()

virtual Parameter<kt_int32s>* karto::ParameterEnum::Clone ( )

inlinevirtual

Return a clone of this instance

Returns

clone

Reimplemented from karto::Parameter< kt_int32s >.

Definition at line 3440 of file Karto.h.

DefineEnumValue()

void karto::ParameterEnum::DefineEnumValue ( kt_int32s  value, const std::string &  rName  )

inline

Defines the enum with the given name as having the given value

Parameters

value
rName

Definition at line 3494 of file Karto.h.

GetValueAsString()

virtual const std::string karto::ParameterEnum::GetValueAsString ( ) const

inlinevirtual

Get parameter value as string.

Returns

value as string

Reimplemented from karto::Parameter< kt_int32s >.

Definition at line 3476 of file Karto.h.

operator=() [1/2]

ParameterEnum& karto::ParameterEnum::operator= ( const ParameterEnum &  rOther )

inline

Assignment operator

Definition at line 3514 of file Karto.h.

operator=() [2/2]

kt_int32s karto::ParameterEnum::operator= ( kt_int32s  value )

inline

Assignment operator

Definition at line 3524 of file Karto.h.

serialize()

template<class Archive >

void karto::ParameterEnum::serialize ( Archive &  ar, const unsigned int  version  )

inlineprivate

Definition at line 3536 of file Karto.h.

SetValueFromString()

virtual void karto::ParameterEnum::SetValueFromString ( const std::string &  rStringValue )

inlinevirtual

Set parameter value from string.

Parameters

rStringValue

value as string

Reimplemented from karto::Parameter< kt_int32s >.

Definition at line 3453 of file Karto.h.

Friends And Related Function Documentation

boost::serialization::access

friend class boost::serialization::access

friend

Definition at line 3534 of file Karto.h.

Member Data Documentation

m_EnumDefines

EnumMap karto::ParameterEnum::m_EnumDefines

private

Definition at line 3532 of file Karto.h.

---

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

• Karto.h