karto::ParameterEnum Class Reference

#include <Karto.h>

Inheritance diagram for karto::ParameterEnum:

[legend]

List of all members.

Public Member Functions
virtual Parameter< kt_int32s > *	Clone ()
void	DefineEnumValue (kt_int32s value, const std::string &rName)
virtual const std::string	GetValueAsString () const
kt_int32s	operator= (kt_int32s value)
ParameterEnum &	operator= (const ParameterEnum &rOther)
	ParameterEnum (const std::string &rName, kt_int32s value, ParameterManager *pParameterManger=NULL)
virtual void	SetValueFromString (const std::string &rStringValue)
virtual	~ParameterEnum ()
Private Types
typedef std::map< std::string, kt_int32s >	EnumMap
Private Attributes
EnumMap	m_EnumDefines

---

Detailed Description

Represent enum parameter

Definition at line 3119 of file Karto.h.

---

Member Typedef Documentation

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

Definition at line 3121 of file Karto.h.

---

Constructor & Destructor Documentation

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

Definition at line 3129 of file Karto.h.

virtual karto::ParameterEnum::~ParameterEnum

(

)

[inline, virtual]

Destructor

Definition at line 3137 of file Karto.h.

---

Member Function Documentation

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

(

)

[inline, virtual]

Return a clone of this instance

Returns:

clone

Reimplemented from karto::Parameter< kt_int32s >.

Definition at line 3146 of file Karto.h.

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 3200 of file Karto.h.

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

(

)

const [inline, virtual]

Get parameter value as string.

Returns:

value as string

Reimplemented from karto::Parameter< kt_int32s >.

Definition at line 3182 of file Karto.h.

kt_int32s karto::ParameterEnum::operator=

(

kt_int32s

value

)

[inline]

Assignment operator

Reimplemented from karto::Parameter< kt_int32s >.

Definition at line 3230 of file Karto.h.

ParameterEnum& karto::ParameterEnum::operator=

(

const ParameterEnum &

rOther

)

[inline]

Assignment operator

Definition at line 3220 of file Karto.h.

virtual void karto::ParameterEnum::SetValueFromString

(

const std::string &

rStringValue

)

[inline, virtual]

Set parameter value from string.

Parameters:

rStringValue

value as string

Reimplemented from karto::Parameter< kt_int32s >.

Definition at line 3159 of file Karto.h.

---

Member Data Documentation

EnumMap karto::ParameterEnum::m_EnumDefines [private]

Definition at line 3238 of file Karto.h.

---

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

• Karto.h