rcsc::ParamGeneric< bool > Class Reference

specialized template class More...

#include <param_map.h>

Inheritance diagram for rcsc::ParamGeneric< bool >:

Collaboration diagram for rcsc::ParamGeneric< bool >:

Public Member Functions
	ParamGeneric (const std::string &long_name, const std::string &short_name, bool *value_ptr, const char *description="")
	constructor More...
	ParamGeneric (const std::string &long_name, const std::string &short_name, const NegateBool &value, const char *description="")
	constructor More...
bool	analyze (const std::string &value_str)
	analyze value string and substitute it to variable. More...
std::ostream &	printValue (std::ostream &os) const
	print value to stream More...
Public Member Functions inherited from rcsc::ParamEntity
virtual	~ParamEntity ()
	destructor as virtual method
const std::string &	longName () const
	get long name of parameter More...
const std::string &	shortName () const
	get long name of parameter More...
const std::string &	description () const
	get description message More...
std::string	helpName () const
	get the formatted name string for help messages More...
virtual bool	isSwitch () const
	(virtual) check if this parameter is switch type or not. More...
virtual bool	analyze (const std::string &value_str)=0
	pure virtual method. analyze value string. More...
virtual std::ostream &	printFormat (std::ostream &os) const
	print help name strings More...
virtual std::ostream &	printValue (std::ostream &os) const =0
	pure virtual method. print value to stream More...

Additional Inherited Members
Public Types inherited from rcsc::ParamEntity
typedef std::shared_ptr< ParamEntity >	Ptr
	ParamEntity smart pointer type.
Protected Member Functions inherited from rcsc::ParamEntity
	ParamEntity (const std::string &long_name, const std::string &short_name, const char *description="")
	construct with all arguments More...

Detailed Description

specialized template class

Constructor & Destructor Documentation

ParamGeneric() [1/2]

rcsc::ParamGeneric< bool >::ParamGeneric ( const std::string &  long_name, const std::string &  short_name, bool *  value_ptr, const char *  description = ""  )

inline

constructor

Parameters

long_name	parameter's long name string
short_name	parameter's short name string(ommitable)
value_ptr	pointer to variable instance
description	description message(ommitable)

ParamGeneric() [2/2]

rcsc::ParamGeneric< bool >::ParamGeneric ( const std::string &  long_name, const std::string &  short_name, const NegateBool &  value, const char *  description = ""  )

inline

constructor

Parameters

long_name	parameter's long name string
short_name	parameter's short name string(ommitable)
value	negate bool object
description	description message(ommitable)

Member Function Documentation

analyze()

bool rcsc::ParamGeneric< bool >::analyze ( const std::string &  value_str )

virtual

analyze value string and substitute it to variable.

Parameters

value_str

string that contains value

Returns

boolean status of analysis result

Implements rcsc::ParamEntity.

printValue()

std::ostream & rcsc::ParamGeneric< bool >::printValue ( std::ostream &  os ) const

virtual

print value to stream

Parameters

os	reference to the stream

Returns

reference to the stream

Implements rcsc::ParamEntity.

---

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

• /home/kali/rc/tools/include/rcsc/param/param_map.h