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

#include <Karto.h>

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

List of all members.

Public Member Functions

virtual ParameterClone ()
const T & GetValue () const
virtual const std::string GetValueAsString () const
template<>
const std::string GetValueAsString () const
template<>
const std::string GetValueAsString () const
Parameteroperator= (const Parameter &rOther)
operator= (T value)
 Parameter (const std::string &rName, T value, ParameterManager *pParameterManger=NULL)
 Parameter (const std::string &rName, const std::string &rDescription, T value, ParameterManager *pParameterManger=NULL)
void SetValue (const T &rValue)
virtual void SetValueFromString (const std::string &rStringValue)
template<>
void SetValueFromString (const std::string &rStringValue)
template<>
void SetValueFromString (const std::string &rStringValue)
virtual ~Parameter ()

Protected Attributes

m_Value

Detailed Description

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

Parameter class

Definition at line 3078 of file Karto.h.


Constructor & Destructor Documentation

template<typename T>
karto::Parameter< T >::Parameter ( const std::string &  rName,
value,
ParameterManager pParameterManger = NULL 
) [inline]

Parameter with given name and value

Parameters:
rName
value
pParameterManger

Definition at line 3087 of file Karto.h.

template<typename T>
karto::Parameter< T >::Parameter ( const std::string &  rName,
const std::string &  rDescription,
value,
ParameterManager pParameterManger = NULL 
) [inline]

Parameter with given name, description and value

Parameters:
rName
rDescription
value
pParameterManger

Definition at line 3100 of file Karto.h.

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

Destructor

Definition at line 3112 of file Karto.h.


Member Function Documentation

template<typename T>
virtual Parameter* karto::Parameter< T >::Clone ( ) [inline, virtual]

Clone this parameter

Returns:
clone of this parameter

Implements karto::AbstractParameter.

Reimplemented in karto::ParameterEnum.

Definition at line 3161 of file Karto.h.

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

Gets value of parameter

Returns:
parameter value

Definition at line 3121 of file Karto.h.

template<typename T>
virtual const std::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 3139 of file Karto.h.

template<>
const std::string karto::Parameter< kt_double >::GetValueAsString ( ) const [inline, virtual]

Get parameter value as string.

Returns:
value as string

Implements karto::AbstractParameter.

Definition at line 3208 of file Karto.h.

template<>
const std::string karto::Parameter< kt_bool >::GetValueAsString ( ) const [inline, virtual]

Get parameter value as string.

Returns:
value as string

Implements karto::AbstractParameter.

Definition at line 3230 of file Karto.h.

template<typename T>
Parameter& karto::Parameter< T >::operator= ( const Parameter< T > &  rOther) [inline]

Assignment operator

Definition at line 3170 of file Karto.h.

template<typename T>
T karto::Parameter< T >::operator= ( value) [inline]

Sets the value of this parameter to given value

Reimplemented in karto::ParameterEnum.

Definition at line 3180 of file Karto.h.

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

Sets value of parameter

Parameters:
rValue

Definition at line 3130 of file Karto.h.

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

Sets value of parameter from string

Parameters:
rStringValue

Implements karto::AbstractParameter.

Reimplemented in karto::ParameterEnum.

Definition at line 3150 of file Karto.h.

template<>
void karto::Parameter< kt_double >::SetValueFromString ( const std::string &  rStringValue) [inline, virtual]

Set parameter value from string.

Parameters:
rStringValuevalue as string

Implements karto::AbstractParameter.

Definition at line 3195 of file Karto.h.

template<>
void karto::Parameter< kt_bool >::SetValueFromString ( const std::string &  rStringValue) [inline, virtual]

Set parameter value from string.

Parameters:
rStringValuevalue as string

Implements karto::AbstractParameter.

Definition at line 3217 of file Karto.h.


Member Data Documentation

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

Parameter value

Definition at line 3191 of file Karto.h.


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


open_karto
Author(s):
autogenerated on Thu Aug 27 2015 14:14:06