karto::Parameter< T > Class Template Reference

#include <Karto.h>

Inheritance diagram for karto::Parameter< T >:

Public Member Functions
virtual Parameter *	Clone ()
const T &	GetValue () const
virtual const std::string	GetValueAsString () const
template<>
const std::string	GetValueAsString () const
template<>
const std::string	GetValueAsString () const
Parameter &	operator= (const Parameter &rOther)
T	operator= (T value)
	Parameter ()
	Parameter (const std::string &rName, T value, ParameterManager *pParameterManger=NULL)
	Parameter (const std::string &rName, const std::string &rDescription, T value, ParameterManager *pParameterManger=NULL)
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)
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 ()
Public Member Functions inherited from karto::AbstractParameter
	AbstractParameter ()
	AbstractParameter (const std::string &rName, ParameterManager *pParameterManger=NULL)
	AbstractParameter (const std::string &rName, const std::string &rDescription, ParameterManager *pParameterManger=NULL)
const std::string &	GetDescription () const
const std::string &	GetName () const
virtual	~AbstractParameter ()

Protected Attributes
T	m_Value

Friends
class	boost::serialization::access

Detailed Description

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

Parameter class

Definition at line 3225 of file Karto.h.

Constructor & Destructor Documentation

Parameter() [1/3]

template<typename T>

karto::Parameter< T >::Parameter ( )

inline

Parameter with given name and value

Parameters

rName
value
pParameterManger

Definition at line 3234 of file Karto.h.

Parameter() [2/3]

template<typename T>

karto::Parameter< T >::Parameter ( const std::string &  rName, T  value, ParameterManager *  pParameterManger = NULL  )

inline

Definition at line 3237 of file Karto.h.

Parameter() [3/3]

template<typename T>

karto::Parameter< T >::Parameter ( const std::string &  rName, const std::string &  rDescription, T  value, ParameterManager *  pParameterManger = NULL  )

inline

Parameter with given name, description and value

Parameters

rName
rDescription
value
pParameterManger

Definition at line 3250 of file Karto.h.

~Parameter()

template<typename T>

virtual karto::Parameter< T >::~Parameter ( )

inlinevirtual

Destructor

Definition at line 3262 of file Karto.h.

Member Function Documentation

Clone()

template<typename T>

virtual Parameter* karto::Parameter< T >::Clone ( )

inlinevirtual

Clone this parameter

Returns

clone of this parameter

Implements karto::AbstractParameter.

Reimplemented in karto::ParameterEnum.

Definition at line 3311 of file Karto.h.

GetValue()

template<typename T>

const T& karto::Parameter< T >::GetValue ( ) const

inline

Gets value of parameter

Returns

parameter value

Definition at line 3271 of file Karto.h.

GetValueAsString() [1/3]

template<typename T>

virtual const std::string karto::Parameter< T >::GetValueAsString ( ) const

inlinevirtual

Gets value of parameter as string

Returns

string version of value

Implements karto::AbstractParameter.

Reimplemented in karto::ParameterEnum.

Definition at line 3289 of file Karto.h.

GetValueAsString() [2/3]

template<>

const std::string karto::Parameter< kt_double >::GetValueAsString ( ) const

inlinevirtual

Get parameter value as string.

Returns

value as string

Implements karto::AbstractParameter.

Definition at line 3370 of file Karto.h.

GetValueAsString() [3/3]

template<>

const std::string karto::Parameter< kt_bool >::GetValueAsString ( ) const

inlinevirtual

Get parameter value as string.

Returns

value as string

Implements karto::AbstractParameter.

Definition at line 3392 of file Karto.h.

operator=() [1/2]

template<typename T>

Parameter& karto::Parameter< T >::operator= ( const Parameter< T > &  rOther )

inline

Assignment operator

Definition at line 3320 of file Karto.h.

operator=() [2/2]

template<typename T>

T karto::Parameter< T >::operator= ( T  value )

inline

Sets the value of this parameter to given value

Definition at line 3330 of file Karto.h.

serialize()

template<typename T>

template<class Archive >

void karto::Parameter< T >::serialize ( Archive &  ar, const unsigned int  version  )

inline

Definition at line 3342 of file Karto.h.

SetValue()

template<typename T>

void karto::Parameter< T >::SetValue ( const T &  rValue )

inline

Sets value of parameter

Parameters

rValue

Definition at line 3280 of file Karto.h.

SetValueFromString() [1/3]

template<typename T>

virtual void karto::Parameter< T >::SetValueFromString ( const std::string &  rStringValue )

inlinevirtual

Sets value of parameter from string

Parameters

rStringValue

Implements karto::AbstractParameter.

Reimplemented in karto::ParameterEnum.

Definition at line 3300 of file Karto.h.

SetValueFromString() [2/3]

template<>

void karto::Parameter< kt_double >::SetValueFromString ( const std::string &  rStringValue )

inlinevirtual

Set parameter value from string.

Parameters

rStringValue

value as string

Implements karto::AbstractParameter.

Definition at line 3357 of file Karto.h.

SetValueFromString() [3/3]

template<>

void karto::Parameter< kt_bool >::SetValueFromString ( const std::string &  rStringValue )

inlinevirtual

Set parameter value from string.

Parameters

rStringValue

value as string

Implements karto::AbstractParameter.

Definition at line 3379 of file Karto.h.

Friends And Related Function Documentation

boost::serialization::access

template<typename T>

friend class boost::serialization::access

friend

Serialization: class Parameter

Definition at line 3340 of file Karto.h.

Member Data Documentation

m_Value

template<typename T>

T karto::Parameter< T >::m_Value

protected

Parameter value

Definition at line 3352 of file Karto.h.

---

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

• Karto.h