karto::AbstractParameter Class Reference

#include <Karto.h>

Inheritance diagram for karto::AbstractParameter:

Public Member Functions
	AbstractParameter (const std::string &rName, ParameterManager *pParameterManger=NULL)
	AbstractParameter (const std::string &rName, const std::string &rDescription, ParameterManager *pParameterManger=NULL)
virtual AbstractParameter *	Clone ()=0
const std::string &	GetDescription () const
const std::string &	GetName () const
virtual const std::string	GetValueAsString () const =0
virtual void	SetValueFromString (const std::string &rStringValue)=0
virtual	~AbstractParameter ()

Private Attributes
std::string	m_Description
std::string	m_Name

Friends
std::ostream &	operator<< (std::ostream &rStream, const AbstractParameter &rParameter)

Detailed Description

Abstract base class for Parameters

Definition at line 2980 of file Karto.h.

Constructor & Destructor Documentation

karto::AbstractParameter::AbstractParameter ( const std::string &  rName, ParameterManager *  pParameterManger = NULL  )

inline

Constructs a parameter with the given name

Parameters

rName
pParameterManger

Definition at line 2988 of file Karto.h.

karto::AbstractParameter::AbstractParameter ( const std::string &  rName, const std::string &  rDescription, ParameterManager *  pParameterManger = NULL  )

inline

Constructs a parameter with the given name and description

Parameters

rName
rDescription
pParameterManger

Definition at line 3004 of file Karto.h.

virtual karto::AbstractParameter::~AbstractParameter ( )

inlinevirtual

Destructor

Definition at line 3020 of file Karto.h.

Member Function Documentation

virtual AbstractParameter* karto::AbstractParameter::Clone ( )

pure virtual

Clones the parameter

Returns

clone

Implemented in karto::ParameterEnum, karto::Parameter< T >, karto::Parameter< kt_bool >, karto::Parameter< std::string >, karto::Parameter< kt_double >, karto::Parameter< kt_int32s >, karto::Parameter< kt_int32u >, and karto::Parameter< karto::Pose2 >.

const std::string& karto::AbstractParameter::GetDescription ( ) const

inline

Returns the parameter description

Returns

parameter description

Definition at line 3038 of file Karto.h.

const std::string& karto::AbstractParameter::GetName ( ) const

inline

Gets the name of this object

Returns

name

Definition at line 3029 of file Karto.h.

virtual const std::string karto::AbstractParameter::GetValueAsString ( ) const

pure virtual

Get parameter value as string.

Returns

value as string

Implemented in karto::ParameterEnum, karto::Parameter< T >, karto::Parameter< T >, karto::Parameter< T >, karto::Parameter< kt_bool >, karto::Parameter< std::string >, karto::Parameter< kt_double >, karto::Parameter< kt_int32s >, karto::Parameter< kt_int32u >, and karto::Parameter< karto::Pose2 >.

virtual void karto::AbstractParameter::SetValueFromString ( const std::string &  rStringValue )

pure virtual

Set parameter value from string.

Parameters

rStringValue

value as string

Implemented in karto::ParameterEnum, karto::Parameter< T >, karto::Parameter< T >, karto::Parameter< T >, karto::Parameter< kt_bool >, karto::Parameter< std::string >, karto::Parameter< kt_double >, karto::Parameter< kt_int32s >, karto::Parameter< kt_int32u >, and karto::Parameter< karto::Pose2 >.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  rStream, const AbstractParameter &  rParameter  )

friend

Write this parameter onto output stream

Parameters

rStream	output stream
rParameter

Definition at line 3067 of file Karto.h.

Member Data Documentation

std::string karto::AbstractParameter::m_Description

private

Definition at line 3078 of file Karto.h.

std::string karto::AbstractParameter::m_Name

private

Definition at line 3077 of file Karto.h.

---

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

• Karto.h