Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes
karto::Parameter< T > Class Template Reference

#include <Parameter.h>

Inheritance diagram for karto::Parameter< T >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual TGetDefaultValue ()
virtual const TGetValue () const
virtual const karto::String GetValueAsString () const
 Parameter (ParameterDescription *pDescription, const T &rValue)
 Parameter (ParameterSet *pParameterSet, const karto::String &rName, const karto::String &rDisplayName, const karto::String &rDescription, const T &rValue)
virtual void SetDefaultValue (const T &rValue)
virtual void SetToDefaultValue ()
virtual void SetValue (const T &rValue)
virtual void SetValueFromString (const karto::String &rStringValue)

Protected Member Functions

kt_bool CompareValue (const T &rValue)
virtual void InitializeParameters ()

Protected Attributes

T m_Value

Private Member Functions

 KARTO_RTTI ()
const Parameteroperator= (const Parameter &)
 Parameter (const Parameter &)

Private Attributes

T m_DefaultValue

Detailed Description

template<typename T>
class karto::Parameter< T >

Parameter

Definition at line 436 of file Parameter.h.


Constructor & Destructor Documentation

template<typename T>
karto::Parameter< T >::Parameter ( ParameterDescription pDescription,
const T rValue 
) [inline]

Parameter with the given description and given value

Parameters:
pDescriptiondescription of the parameter
rValueparameter value

Definition at line 446 of file Parameter.h.

template<typename T>
karto::Parameter< T >::Parameter ( ParameterSet pParameterSet,
const karto::String rName,
const karto::String rDisplayName,
const karto::String rDescription,
const T rValue 
) [inline]

Parameter for the set of parameters with the given name, display name, description and value

Parameters:
pParameterSetset of parameters
rNamename of the parameter
rDisplayNamedisplay name of the parameter
rDescriptiondescription of the parameter
rValueparameter value

Definition at line 461 of file Parameter.h.

template<typename T>
karto::Parameter< T >::Parameter ( const Parameter< T > &  ) [private]

Member Function Documentation

template<typename T>
kt_bool karto::Parameter< T >::CompareValue ( const T rValue) [inline, protected]

Compares if the given value is equal to current value

Parameters:
rValuevalue to compare against
Returns:
true if equal

Definition at line 566 of file Parameter.h.

template<typename T>
virtual T& karto::Parameter< T >::GetDefaultValue ( ) [inline, virtual]

Gets the default value of parameter

Returns:
parameter value

Definition at line 508 of file Parameter.h.

template<typename T>
virtual const T& karto::Parameter< T >::GetValue ( ) const [inline, virtual]

Gets the value of parameter

Returns:
parameter value

Definition at line 483 of file Parameter.h.

template<typename T>
virtual const karto::String karto::Parameter< T >::GetValueAsString ( ) const [inline, virtual]

Gets value of parameter as string

Returns:
string version of value

Implements karto::AbstractParameter.

Reimplemented in karto::ParameterEnum.

Definition at line 526 of file Parameter.h.

template<typename T>
virtual void karto::Parameter< T >::InitializeParameters ( ) [inline, protected, virtual]

Initialize parameters

Reimplemented from karto::AbstractParameter.

Definition at line 556 of file Parameter.h.

template<typename T>
karto::Parameter< T >::KARTO_RTTI ( ) [private]

Reimplemented from karto::AbstractParameter.

Reimplemented in karto::ParameterEnum.

template<typename T>
const Parameter& karto::Parameter< T >::operator= ( const Parameter< T > &  ) [private]
template<typename T>
virtual void karto::Parameter< T >::SetDefaultValue ( const T rValue) [inline, virtual]

Sets the default value of parameter

Parameters:
rValuevalue to set as default

Definition at line 517 of file Parameter.h.

template<typename T>
virtual void karto::Parameter< T >::SetToDefaultValue ( ) [inline, virtual]

Set parameter value to default value

Implements karto::AbstractParameter.

Definition at line 547 of file Parameter.h.

template<typename T>
virtual void karto::Parameter< T >::SetValue ( const T rValue) [inline, virtual]

Sets the value of parameter

Parameters:
rValuevalue to set parameter to

Definition at line 492 of file Parameter.h.

template<typename T>
virtual void karto::Parameter< T >::SetValueFromString ( const karto::String rStringValue) [inline, virtual]

Sets the value of parameter from string

Parameters:
rStringValuestring

Implements karto::AbstractParameter.

Reimplemented in karto::ParameterEnum.

Definition at line 535 of file Parameter.h.


Member Data Documentation

template<typename T>
T karto::Parameter< T >::m_DefaultValue [private]

Parameter default value

Definition at line 586 of file Parameter.h.

template<typename T>
T karto::Parameter< T >::m_Value [protected]

Parameter value

Definition at line 580 of file Parameter.h.


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


nav2d_karto
Author(s): Sebastian Kasperski
autogenerated on Sun Apr 2 2017 04:05:24