Public Member Functions | Private Types | Private Attributes
karto::ParameterEnum Class Reference

#include <Karto.h>

Inheritance diagram for karto::ParameterEnum:
Inheritance graph
[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
ParameterEnumoperator= (const ParameterEnum &rOther)
kt_int32s operator= (kt_int32s value)
 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

Parameter enum class

Definition at line 3258 of file Karto.h.


Member Typedef Documentation

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

Definition at line 3260 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:
rNameparameter name
valueof parameter
pParameterManger

Definition at line 3269 of file Karto.h.

virtual karto::ParameterEnum::~ParameterEnum ( ) [inline, virtual]

Destructor

Definition at line 3277 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 3286 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 3340 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 3322 of file Karto.h.

ParameterEnum& karto::ParameterEnum::operator= ( const ParameterEnum rOther) [inline]

Assignment operator

Definition at line 3360 of file Karto.h.

kt_int32s karto::ParameterEnum::operator= ( kt_int32s  value) [inline]

Assignment operator

Reimplemented from karto::Parameter< kt_int32s >.

Definition at line 3370 of file Karto.h.

virtual void karto::ParameterEnum::SetValueFromString ( const std::string &  rStringValue) [inline, virtual]

Set parameter value from string.

Parameters:
rStringValuevalue as string

Reimplemented from karto::Parameter< kt_int32s >.

Definition at line 3299 of file Karto.h.


Member Data Documentation

Definition at line 3378 of file Karto.h.


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


open_karto
Author(s):
autogenerated on Tue May 2 2017 02:41:15