Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
karto::ParameterEnum Class Reference

#include <Parameter.h>

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

Public Member Functions

void DefineEnumValue (const String &rName, kt_int64s value)
 
const EnumPairList GetEnumValues () const
 
 ParameterEnum (ParameterSet *pParameterSet, const karto::String &rName, const karto::String &rDisplayName, const karto::String &rDescription, kt_int64s value)
 
- Public Member Functions inherited from karto::Parameter< kt_int64s >
 Parameter (ParameterDescription *pDescription, const kt_int64s &rValue)
 
 Parameter (ParameterSet *pParameterSet, const karto::String &rName, const karto::String &rDisplayName, const karto::String &rDescription, const kt_int64s &rValue)
 
- Public Member Functions inherited from karto::AbstractParameter
 AbstractParameter (ParameterDescription *pDescription, ParameterSet *pParameterSet=NULL)
 
const karto::StringGetDescription () const
 
const karto::StringGetDisplayName () const
 
kt_int32s GetFlags () const
 
const karto::StringGetName () const
 
const ParameterDescriptionGetParameterDescription () const
 
ParameterDescriptionGetParameterDescription ()
 
- Public Member Functions inherited from karto::Referenced
 Referenced ()
 

Protected Member Functions

virtual const karto::String GetValueAsString () const
 
virtual void SetValueFromString (const karto::String &rStringValue)
 
- Protected Member Functions inherited from karto::Parameter< kt_int64s >
kt_bool CompareValue (const kt_int64s &rValue)
 
virtual kt_int64sGetDefaultValue ()
 
virtual const kt_int64sGetValue () const
 
virtual void InitializeParameters ()
 
virtual void SetDefaultValue (const kt_int64s &rValue)
 
virtual void SetToDefaultValue ()
 
virtual void SetValue (const kt_int64s &rValue)
 
- Protected Member Functions inherited from karto::Referenced
kt_int32s GetReferenceCount ()
 
kt_int32s Reference () const
 
kt_int32s Unreference () const
 
kt_int32s UnreferenceNoDelete () const
 

Private Member Functions

 KARTO_RTTI ()
 

Private Attributes

ParameterEnumPrivatem_pPrivate
 

Additional Inherited Members

- Protected Attributes inherited from karto::Parameter< kt_int64s >
kt_int64s m_Value
 
- Protected Attributes inherited from karto::AbstractParameter
BasicEvent< EventArgumentsChanged
 

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.

const EnumPairList karto::ParameterEnum::GetEnumValues ( ) const

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.

const String karto::ParameterEnum::GetValueAsString ( ) const
protectedvirtual

public: /** 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.

karto::ParameterEnum::KARTO_RTTI ( )
private
void karto::ParameterEnum::SetValueFromString ( const karto::String rStringValue)
protectedvirtual

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

ParameterEnumPrivate* karto::ParameterEnum::m_pPrivate
private

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 Tue Nov 7 2017 06:02:36