karto::AbstractParameter Class Reference

#include <Parameter.h>

Inheritance diagram for karto::AbstractParameter:

List of all members.

Public Member Functions
	AbstractParameter (ParameterDescription *pDescription, ParameterSet *pParameterSet=NULL)
const karto::String &	GetDescription () const
const karto::String &	GetDisplayName () const
kt_int32s	GetFlags () const
const karto::String &	GetName () const
const ParameterDescription *	GetParameterDescription () const
ParameterDescription *	GetParameterDescription ()
virtual const karto::String	GetValueAsString () const =0
virtual void	SetToDefaultValue ()=0
virtual void	SetValueFromString (const karto::String &rStringValue)=0
Public Attributes
BasicEvent< EventArguments >	Changed
Protected Member Functions
virtual void	InitializeParameters ()
Private Member Functions
	AbstractParameter (const AbstractParameter &)
	KARTO_RTTI ()
const AbstractParameter &	operator= (const AbstractParameter &)
Private Attributes
karto::SmartPointer < ParameterDescription >	m_pDescription
ParameterSet *	m_pParameterSet

---

Detailed Description

Abstract base class for parameters

Definition at line 220 of file Parameter.h.

---

Constructor & Destructor Documentation

karto::AbstractParameter::AbstractParameter	(	ParameterDescription *	pDescription,
		ParameterSet *	pParameterSet = NULL
	)

Constructs an AbstractParameter with the given ParameterDescription and ParameterSet

Parameters:

pDescription	description of parameter
pParameterSet	set of parameters

Definition at line 56 of file Parameter.cpp.

karto::AbstractParameter::AbstractParameter

(

const AbstractParameter &

)

[private]

---

Member Function Documentation

const karto::String& karto::AbstractParameter::GetDescription

(

)

const [inline]

Gets the description of this parameter

Returns:

description

Definition at line 269 of file Parameter.h.

const karto::String& karto::AbstractParameter::GetDisplayName

(

)

const [inline]

Gets the display name of this parameter

Returns:

display name

Definition at line 260 of file Parameter.h.

kt_int32s karto::AbstractParameter::GetFlags

(

)

const [inline]

Gets the flags of this parameter

Returns:

flags

Definition at line 278 of file Parameter.h.

const karto::String& karto::AbstractParameter::GetName

(

)

const [inline]

Gets the name of this parameter

Returns:

name

Definition at line 251 of file Parameter.h.

const ParameterDescription* karto::AbstractParameter::GetParameterDescription

(

)

const [inline]

Gets the parameter description for this parameter (const version)

Returns:

parameter description

Definition at line 287 of file Parameter.h.

ParameterDescription* karto::AbstractParameter::GetParameterDescription

(

)

[inline]

Gets the parameter description for this parameter

Returns:

parameter description

Definition at line 296 of file Parameter.h.

virtual const karto::String karto::AbstractParameter::GetValueAsString

(

)

const [pure virtual]

Gets the parameter value as string.

Returns:

value as string

Implemented in karto::ParameterEnum, karto::Parameter< T >, karto::Parameter< Pose2 >, karto::Parameter< kt_bool >, karto::Parameter< kt_int64s >, karto::Parameter< String >, karto::Parameter< kt_double >, and karto::Parameter< kt_int32u >.

void karto::AbstractParameter::InitializeParameters

(

)

[protected, virtual]

Initialize parameters

Reimplemented in karto::Parameter< T >, karto::Parameter< Pose2 >, karto::Parameter< kt_bool >, karto::Parameter< kt_int64s >, karto::Parameter< String >, karto::Parameter< kt_double >, and karto::Parameter< kt_int32u >.

Definition at line 67 of file Parameter.cpp.

karto::AbstractParameter::KARTO_RTTI

(

)

[private]

Reimplemented in karto::ParameterEnum, karto::Parameter< T >, karto::Parameter< Pose2 >, karto::Parameter< kt_bool >, karto::Parameter< kt_int64s >, karto::Parameter< String >, karto::Parameter< kt_double >, and karto::Parameter< kt_int32u >.

const AbstractParameter& karto::AbstractParameter::operator=

(

const AbstractParameter &

)

[private]

virtual void karto::AbstractParameter::SetToDefaultValue

(

)

[pure virtual]

Sets the parameter to its default value

Implemented in karto::Parameter< T >, karto::Parameter< Pose2 >, karto::Parameter< kt_bool >, karto::Parameter< kt_int64s >, karto::Parameter< String >, karto::Parameter< kt_double >, and karto::Parameter< kt_int32u >.

virtual void karto::AbstractParameter::SetValueFromString

(

const karto::String &

rStringValue

)

[pure virtual]

Sets the parameter value from string.

Parameters:

rStringValue

value as string

Implemented in karto::ParameterEnum, karto::Parameter< T >, karto::Parameter< Pose2 >, karto::Parameter< kt_bool >, karto::Parameter< kt_int64s >, karto::Parameter< String >, karto::Parameter< kt_double >, and karto::Parameter< kt_int32u >.

---

Member Data Documentation

BasicEvent<EventArguments> karto::AbstractParameter::Changed

Parameter event for changed notification

Definition at line 244 of file Parameter.h.

karto::SmartPointer<ParameterDescription> karto::AbstractParameter::m_pDescription [private]

Definition at line 330 of file Parameter.h.

ParameterSet* karto::AbstractParameter::m_pParameterSet [private]

Definition at line 331 of file Parameter.h.

---

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

• Parameter.h
• Parameter.cpp