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

Protected Attributes

m_Value

Detailed Description

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

Definition at line 2959 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 

Definition at line 2967 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 
value 

Definition at line 2978 of file Karto.h.

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

Destructor

Definition at line 2987 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 3036 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 2996 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 3102 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 3080 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 3014 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 3055 of file Karto.h.

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

Assignment operator

Definition at line 3045 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 3005 of file Karto.h.

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

Set parameter value from string.

Parameters:
rStringValue value as string

Implements karto::AbstractParameter.

Definition at line 3089 of file Karto.h.

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

Set parameter value from string.

Parameters:
rStringValue value as string

Implements karto::AbstractParameter.

Definition at line 3067 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 3025 of file Karto.h.


Member Data Documentation

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

Definition at line 3063 of file Karto.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines


karto
Author(s): SRI International (package maintained by Brian Gerkey)
autogenerated on Fri Jan 11 10:07:06 2013