Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
karto::AbstractParameter Class Referenceabstract

#include <Parameter.h>

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

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 Member Functions inherited from karto::Referenced
 Referenced ()
 

Protected Member Functions

virtual void InitializeParameters ()
 
- Protected Member Functions inherited from karto::Referenced
kt_int32s GetReferenceCount ()
 
kt_int32s Reference () const
 
kt_int32s Unreference () const
 
kt_int32s UnreferenceNoDelete () const
 

Protected Attributes

BasicEvent< EventArgumentsChanged
 

Private Member Functions

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

Private Attributes

karto::SmartPointer< ParameterDescriptionm_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.

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
void karto::AbstractParameter::InitializeParameters ( )
protectedvirtual
karto::AbstractParameter::KARTO_RTTI ( )
private
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

BasicEvent<EventArguments> karto::AbstractParameter::Changed
protected

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


nav2d_karto
Author(s): Sebastian Kasperski
autogenerated on Thu Jun 6 2019 19:20:25