Public Member Functions | Private Attributes | Friends
karto::AbstractParameter Class Reference

#include <Karto.h>

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

List of all members.

Public Member Functions

 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 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 2969 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 2977 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 2993 of file Karto.h.

virtual karto::AbstractParameter::~AbstractParameter ( ) [inline, virtual]

Destructor

Definition at line 3009 of file Karto.h.


Member Function Documentation

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

Returns the parameter description

Returns:
parameter description

Definition at line 3027 of file Karto.h.

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

Gets the name of this object

Returns:
name

Definition at line 3018 of file Karto.h.

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

Friends And Related Function Documentation

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

Write this parameter onto output stream

Parameters:
rStreamoutput stream
rParameter

Definition at line 3056 of file Karto.h.


Member Data Documentation

Definition at line 3067 of file Karto.h.

std::string karto::AbstractParameter::m_Name [private]

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