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

#include <Parameter.h>

Inheritance diagram for karto::ParameterEnum:
Inheritance graph
[legend]

List of all members.

Public Member Functions

void DefineEnumValue (const String &rName, kt_int64s value)
const EnumPairList GetEnumValues () const
virtual const karto::String GetValueAsString () const
 ParameterEnum (ParameterSet *pParameterSet, const karto::String &rName, const karto::String &rDisplayName, const karto::String &rDescription, kt_int64s value)
virtual void SetValueFromString (const karto::String &rStringValue)

Private Member Functions

 KARTO_RTTI ()

Private Attributes

ParameterEnumPrivatem_pPrivate

Detailed Description

Parameter enum class

Definition at line 748 of file Parameter.h.


Constructor & Destructor Documentation

karto::ParameterEnum::ParameterEnum ( ParameterSet pParameterSet,
const karto::String rName,
const karto::String rDisplayName,
const karto::String rDescription,
kt_int64s  value 
)

Enumeration parameter

Parameters:
pParameterSetset this parameter enumeration will belong to
rNamename
rDisplayNamedisplay name
rDescriptiondescription
valuevalue

Definition at line 175 of file Parameter.cpp.


Member Function Documentation

void karto::ParameterEnum::DefineEnumValue ( const String rName,
kt_int64s  value 
)

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

Parameters:
rNamename of enum
valuevalue of enum

Definition at line 219 of file Parameter.cpp.

Gets the list of enum pairs associated with this parameter

Returns:
list of enum pairs associated with this parameter

Definition at line 237 of file Parameter.cpp.

Gets the parameter value as string.

Returns:
value as string
Exceptions:
Exceptionif unable to convert enum to string

Reimplemented from karto::Parameter< kt_int64s >.

Definition at line 206 of file Parameter.cpp.

Reimplemented from karto::Parameter< kt_int64s >.

void karto::ParameterEnum::SetValueFromString ( const karto::String rStringValue) [virtual]

Sets the parameter value from string.

Parameters:
rStringValuevalue as string
Exceptions:
Exceptionif unable to set enum value

Reimplemented from karto::Parameter< kt_int64s >.

Definition at line 186 of file Parameter.cpp.


Member Data Documentation

Definition at line 801 of file Parameter.h.


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


nav2d_karto
Author(s): Sebastian Kasperski
autogenerated on Mon Oct 6 2014 02:44:18