ParamT< T > Class Template Reference

Template parameter class. More...

#include <param.h>

Inheritance diagram for ParamT< T >:

Public Member Functions
	ParamT (const char *const STR_Keyword, const T &T_Default, const Help &CLI_Help)
	Constructor. More...
virtual	~ParamT (void)
	Destructor. More...
	operator const T (void) const
	Implicit cast operator. More...
virtual const Param &	CopyValue (const Param &CLI_Param) const
	Value copy handler. More...
Public Member Functions inherited from Param
virtual	~Param (void)
	Destructor. More...
virtual const tk::String	GetKeyword (void) const
	String identifier accessor. More...
virtual const bool	FindElements (Element::List &CLI_ExactList, Element::List &CLI_NearList, const char *const STR_Keyword) const
	Sub-elements search. More...
virtual const bool	SetstrValue (const char *const STR_Value) const =0
	Value setting. More...
const tk::String	GetstrValue (void) const
	Value access in its string form. More...
virtual const Param *const	Clone (void) const =0
	Parameter cloning handler. More...
const Param *const	GetCloned (void) const
	Cloned parameter access. More...
Public Member Functions inherited from SyntaxNode
	SyntaxNode (const char *const STR_Keyword, const Help &CLI_Help)
	Constructor. More...
virtual	~SyntaxNode (void)
	Destructor. More...
Element &	AddElement (Element *const PCLI_Element)
	Possible element addition. More...
const bool	RemoveElement (const Element *const PCLI_Element, const bool B_AutoDelete)
	Element removal. More...
Public Member Functions inherited from Element
	Element (const char *const STR_Keyword, const Help &STR_Help)
	Constructor. More...
virtual	~Element (void)=0
	Destructor. More...
virtual const Help &	GetHelp (void) const
	Element help accessor. More...
virtual void	SetCli (Cli &CLI_Cli)
	Cli reference setting. More...
Cli &	GetCli (void)
	Read-Write Cli reference accessor. More...
const Cli &	GetCli (void) const
	Read-only Cli reference accessor. More...
Shell &	GetShell (void) const
	Shell reference accessor. More...
const OutputDevice &	GetOutputStream (void) const
	Output stream reference accessor. More...
const OutputDevice &	GetErrorStream (void) const
	Error stream reference accessor. More...
Public Member Functions inherited from Object
virtual	~Object (void)=0
	Pure virtual destructor. More...

Protected Member Functions
void	SetValue (const char *const STR_Value, const T &T_Value) const
	Value setting for derived class. More...
Protected Member Functions inherited from Param
	Param (const char *const STR_Keyword, const Help &CLI_Help)
	Constructor. More...
const bool	SetValue (const char *const STR_Value) const
	Value setting from derived class. More...
const Param *const	InitClone (Param &CLI_CloneParam) const
	Clone initialization. More...
const bool	SetCloned (const Param &CLI_Cloned)
	Cloned parameter reference setting. More...
Protected Member Functions inherited from Object
	Object (void)
	Default constructor only available to sub-classes. More...

Additional Inherited Members
Public Types inherited from Element
typedef tk::Queue< const Element * >	List
	CLI element list type. More...
typedef tk::Map< const tk::String, const Element * >	Map
	CLI element map type. More...

Detailed Description

template<class T>
class ParamT< T >

Template parameter class.

Definition at line 137 of file param.h.

Constructor & Destructor Documentation

ParamT()

template<class T>

ParamT< T >::ParamT ( const char *const  STR_Keyword, const T &  T_Default, const Help &  CLI_Help  )

inlineexplicit

Constructor.

Parameters

STR_Keyword	Keyword.
T_Default	Default value.
CLI_Help	Corresponding help.

Definition at line 141 of file param.h.

~ParamT()

template<class T>

virtual ParamT< T >::~ParamT ( void  )

inlinevirtual

Destructor.

Definition at line 152 of file param.h.

Member Function Documentation

CopyValue()

template<class T>

virtual const Param& ParamT< T >::CopyValue ( const Param &  CLI_Param ) const

inlinevirtual

Value copy handler.

Parameters

CLI_Param

Parameter to copy the value from.

Returns

The Param instance itself.

Implements Param.

Definition at line 172 of file param.h.

operator const T()

template<class T>

ParamT< T >::operator const T ( void  ) const

inline

Implicit cast operator.

Definition at line 166 of file param.h.

SetValue()

template<class T>

void ParamT< T >::SetValue ( const char *const  STR_Value, const T &  T_Value  ) const

inlineprotected

Value setting for derived class.

Parameters

STR_Value	New value in its string form.
T_Value	New value in its typed form.

Definition at line 183 of file param.h.

Referenced by ParamT< int >::CopyValue().

---

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

• param.h