Public Member Functions | Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes
karto::AbstractParameter Class Reference

#include <Parameter.h>

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

List of all members.

Public Member Functions

 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 ()
virtual const karto::String GetValueAsString () const =0
virtual void SetToDefaultValue ()=0
virtual void SetValueFromString (const karto::String &rStringValue)=0

Public Attributes

BasicEvent< EventArgumentsChanged

Protected Member Functions

virtual void InitializeParameters ()

Private Member Functions

 AbstractParameter (const AbstractParameter &)
 KARTO_RTTI ()
const AbstractParameteroperator= (const AbstractParameter &)

Private Attributes

karto::SmartPointer
< ParameterDescription
m_pDescription
ParameterSetm_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:
pDescriptiondescription of parameter
pParameterSetset of parameters

Definition at line 56 of file Parameter.cpp.


Member Function Documentation

Gets the description of this parameter

Returns:
description

Definition at line 269 of file Parameter.h.

Gets the display name of this parameter

Returns:
display name

Definition at line 260 of file Parameter.h.

Gets the flags of this parameter

Returns:
flags

Definition at line 278 of file Parameter.h.

Gets the name of this parameter

Returns:
name

Definition at line 251 of file Parameter.h.

Gets the parameter description for this parameter (const version)

Returns:
parameter description

Definition at line 287 of file Parameter.h.

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]
void karto::AbstractParameter::InitializeParameters ( ) [protected, virtual]
const AbstractParameter& karto::AbstractParameter::operator= ( const AbstractParameter ) [private]
virtual void karto::AbstractParameter::SetToDefaultValue ( ) [pure virtual]
virtual void karto::AbstractParameter::SetValueFromString ( const karto::String rStringValue) [pure virtual]

Member Data Documentation

Parameter event for changed notification

Definition at line 244 of file Parameter.h.

Definition at line 330 of file Parameter.h.

Definition at line 331 of file Parameter.h.


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


nav2d_karto
Author(s): Sebastian Kasperski
autogenerated on Sun Apr 2 2017 03:53:09