ctd::file::Parameter Class Reference

Class to handle information for one parameter. More...

#include <Parameter.hpp>

Public Member Functions
	Parameter ()
	Parameter (const std::string name, const std::string value, const std::string comment="")
	Constructor settting internal members. More...
	Parameter (const Parameter &source)
	Copy constructor. More...
	~Parameter ()
Parameter &	Clear ()
	Clear the internal members. More...
Parameter &	SetName (const std::string name)
	Set parameter name. More...
std::string	GetName () const
	Return parameter name. More...
Parameter &	SetValue (const std::string value)
	Set parameter value. More...
std::string	GetValueAsString () const
	Get parameter value as a string. More...
bool	NoValue () const
	Return true if no value has been set for the parameter. More...
template<class TYPE >
void	GetValue (TYPE &value) const
	Get parameter value as its native data type. More...
Parameter &	SetComment (const std::string &comment)
	Set parameter comment. More...
std::string	GetComment () const
	Get parameter comment. More...
std::string	Print () const
	Print out parameter. More...
Parameter &	operator= (const Parameter &source)
	Copy operator. More...
	Parameter ()
	Parameter (const std::string name, const std::string value, const std::string comment="")
	Constructor settting internal members. More...
	Parameter (const Parameter &source)
	Copy constructor. More...
	~Parameter ()
Parameter &	Clear ()
	Clear the internal members. More...
Parameter &	SetName (const std::string name)
	Set parameter name. More...
std::string	GetName () const
	Return parameter name. More...
Parameter &	SetValue (const std::string value)
	Set parameter value. More...
std::string	GetValueAsString () const
	Get parameter value as a string. More...
bool	NoValue () const
	Return true if no value has been set for the parameter. More...
template<class TYPE >
void	GetValue (TYPE &value) const
	Get parameter value as its native data type. More...
Parameter &	SetComment (const std::string &comment)
	Set parameter comment. More...
std::string	GetComment () const
	Get parameter comment. More...
std::string	Print () const
	Print out parameter. More...
Parameter &	operator= (const Parameter &source)
	Copy operator. More...
	Parameter ()
	Parameter (const std::string name, const std::string value, const std::string comment="")
	Constructor settting internal members. More...
	Parameter (const Parameter &source)
	Copy constructor. More...
	~Parameter ()
Parameter &	Clear ()
	Clear the internal members. More...
Parameter &	SetName (const std::string name)
	Set parameter name. More...
std::string	GetName () const
	Return parameter name. More...
Parameter &	SetValue (const std::string value)
	Set parameter value. More...
std::string	GetValueAsString () const
	Get parameter value as a string. More...
bool	NoValue () const
	Return true if no value has been set for the parameter. More...
template<class TYPE >
void	GetValue (TYPE &value) const
	Get parameter value as its native data type. More...
Parameter &	SetComment (const std::string &comment)
	Set parameter comment. More...
std::string	GetComment () const
	Get parameter comment. More...
std::string	Print () const
	Print out parameter. More...
Parameter &	operator= (const Parameter &source)
	Copy operator. More...

Static Public Attributes
static const std::string	NO_VALUE = "__NO__VALUE__"

Protected Attributes
std::string	m_name
std::string	m_value
std::string	m_comment

Detailed Description

Class to handle information for one parameter.

Constructor & Destructor Documentation

ctd::file::Parameter::Parameter

(

)

ctd::file::Parameter::Parameter	(	const std::string	name,
		const std::string	value,
		const std::string	comment = ""
	)

Constructor settting internal members.

ctd::file::Parameter::Parameter

(

const Parameter &

source

)

Copy constructor.

ctd::file::Parameter::~Parameter

(

)

ctd::file::Parameter::Parameter

(

)

ctd::file::Parameter::Parameter	(	const std::string	name,
		const std::string	value,
		const std::string	comment = ""
	)

Constructor settting internal members.

ctd::file::Parameter::Parameter

(

const Parameter &

source

)

Copy constructor.

ctd::file::Parameter::~Parameter

(

)

ctd::file::Parameter::Parameter

(

)

ctd::file::Parameter::Parameter	(	const std::string	name,
		const std::string	value,
		const std::string	comment = ""
	)

Constructor settting internal members.

ctd::file::Parameter::Parameter

(

const Parameter &

source

)

Copy constructor.

ctd::file::Parameter::~Parameter

(

)

Member Function Documentation

Parameter & ctd::file::Parameter::Clear

(

)

Clear the internal members.

Parameter& ctd::file::Parameter::Clear

(

)

Clear the internal members.

Parameter& ctd::file::Parameter::Clear

(

)

Clear the internal members.

std::string ctd::file::Parameter::GetComment

(

)

const

Get parameter comment.

std::string ctd::file::Parameter::GetComment

(

)

const

Get parameter comment.

std::string ctd::file::Parameter::GetComment

(

)

const

Get parameter comment.

std::string ctd::file::Parameter::GetName

(

)

const

Return parameter name.

std::string ctd::file::Parameter::GetName

(

)

const

Return parameter name.

std::string ctd::file::Parameter::GetName

(

)

const

Return parameter name.

template<class TYPE >

void ctd::file::Parameter::GetValue ( TYPE &  value ) const

inline

Get parameter value as its native data type.

template<class TYPE >

void ctd::file::Parameter::GetValue ( TYPE &  value ) const

inline

Get parameter value as its native data type.

template<class TYPE >

void ctd::file::Parameter::GetValue ( TYPE &  value ) const

inline

Get parameter value as its native data type.

std::string ctd::file::Parameter::GetValueAsString

(

)

const

Get parameter value as a string.

std::string ctd::file::Parameter::GetValueAsString

(

)

const

Get parameter value as a string.

std::string ctd::file::Parameter::GetValueAsString

(

)

const

Get parameter value as a string.

bool ctd::file::Parameter::NoValue

(

)

const

Return true if no value has been set for the parameter.

bool ctd::file::Parameter::NoValue

(

)

const

Return true if no value has been set for the parameter.

bool ctd::file::Parameter::NoValue

(

)

const

Return true if no value has been set for the parameter.

Parameter& ctd::file::Parameter::operator=

(

const Parameter &

source

)

Copy operator.

Parameter & ctd::file::Parameter::operator=

(

const Parameter &

source

)

Copy operator.

Parameter& ctd::file::Parameter::operator=

(

const Parameter &

source

)

Copy operator.

std::string ctd::file::Parameter::Print

(

)

const

Print out parameter.

std::string ctd::file::Parameter::Print

(

)

const

Print out parameter.

std::string ctd::file::Parameter::Print

(

)

const

Print out parameter.

Parameter& ctd::file::Parameter::SetComment

(

const std::string &

comment

)

Set parameter comment.

Parameter & ctd::file::Parameter::SetComment

(

const std::string &

comment

)

Set parameter comment.

Parameter& ctd::file::Parameter::SetComment

(

const std::string &

comment

)

Set parameter comment.

Parameter& ctd::file::Parameter::SetName

(

const std::string

name

)

Set parameter name.

Parameter& ctd::file::Parameter::SetName

(

const std::string

name

)

Set parameter name.

Parameter & ctd::file::Parameter::SetName

(

const std::string

name

)

Set parameter name.

Parameter& ctd::file::Parameter::SetValue

(

const std::string

value

)

Set parameter value.

Parameter & ctd::file::Parameter::SetValue

(

const std::string

value

)

Set parameter value.

Parameter& ctd::file::Parameter::SetValue

(

const std::string

value

)

Set parameter value.

Member Data Documentation

std::string ctd::file::Parameter::m_comment

protected

std::string ctd::file::Parameter::m_name

protected

std::string ctd::file::Parameter::m_value

protected

const std::string ctd::file::Parameter::NO_VALUE = "__NO__VALUE__"

static

---

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

• ctd/file/src/include/ctd/file/Parameter.hpp
• INTROOT/include/ctd/file/Parameter.hpp
• INTROOT/sources/ctd/file/src/include/ctd/file/Parameter.hpp
• ctd/file/src/Parameter.cpp
• INTROOT/sources/ctd/file/src/Parameter.cpp