Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
karto::AbstractParameter Class Referenceabstract

#include <Karto.h>

Inheritance diagram for karto::AbstractParameter:
Inheritance graph
[legend]

Public Member Functions

 AbstractParameter ()
 
 AbstractParameter (const std::string &rName, ParameterManager *pParameterManger=NULL)
 
 AbstractParameter (const std::string &rName, const std::string &rDescription, ParameterManager *pParameterManger=NULL)
 
virtual AbstractParameterClone ()=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 Member Functions

template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Private Attributes

std::string m_Description
 
std::string m_Name
 

Friends

class boost::serialization::access
 
std::ostream & operator<< (std::ostream &rStream, const AbstractParameter &rParameter)
 

Detailed Description

Abstract base class for Parameters

Definition at line 3101 of file Karto.h.

Constructor & Destructor Documentation

◆ AbstractParameter() [1/3]

karto::AbstractParameter::AbstractParameter ( )
inline

Definition at line 3105 of file Karto.h.

◆ AbstractParameter() [2/3]

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

Constructs a parameter with the given name

Parameters
rName
pParameterManger

Definition at line 3113 of file Karto.h.

◆ AbstractParameter() [3/3]

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 3129 of file Karto.h.

◆ ~AbstractParameter()

virtual karto::AbstractParameter::~AbstractParameter ( )
inlinevirtual

Destructor

Definition at line 3145 of file Karto.h.

Member Function Documentation

◆ Clone()

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

◆ GetDescription()

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

Returns the parameter description

Returns
parameter description

Definition at line 3163 of file Karto.h.

◆ GetName()

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

Gets the name of this object

Returns
name

Definition at line 3154 of file Karto.h.

◆ GetValueAsString()

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

◆ serialize()

template<class Archive >
void karto::AbstractParameter::serialize ( Archive &  ar,
const unsigned int  version 
)
inlineprivate

Definition at line 3209 of file Karto.h.

◆ SetValueFromString()

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

Friends And Related Function Documentation

◆ boost::serialization::access

friend class boost::serialization::access
friend

Serialization: class AbstractParameter

Definition at line 3207 of file Karto.h.

◆ operator<<

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

Write this parameter onto output stream

Parameters
rStreamoutput stream
rParameter

Definition at line 3192 of file Karto.h.

Member Data Documentation

◆ m_Description

std::string karto::AbstractParameter::m_Description
private

Definition at line 3203 of file Karto.h.

◆ m_Name

std::string karto::AbstractParameter::m_Name
private

Definition at line 3202 of file Karto.h.


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


slam_toolbox
Author(s): Steve Macenski
autogenerated on Sat Oct 3 2020 03:51:02