ParamString Class Reference

String parameter element class. More...

#include <param_string.h>

Inheritance diagram for ParamString:

Public Member Functions
	ParamString (const Help &CLI_Help)
	Constructor. More...
virtual	~ParamString (void)
	Destructor. More...
	operator const char *const (void) const
	Implicit cast operator. More...
virtual const bool	SetstrValue (const char *const STR_Value) const
	Value setting. More...
virtual const Param &	CopyValue (const Param &CLI_Param) const
	Value copy handler. More...
virtual const Param *const	Clone (void) const
	Parameter cloning 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...
const tk::String	GetstrValue (void) const
	Value access in its string form. 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
	ParamString (const char *const STR_Keyword, const Help &CLI_Help)
	Sub-classes constructor. 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

String parameter element class.

Definition at line 47 of file param_string.h.

Constructor & Destructor Documentation

ParamString() [1/2]

ParamString::ParamString ( const Help &  CLI_Help )

explicit

Constructor.

Parameters

CLI_Help

Corresponding help.

ParamString() [2/2]

ParamString::ParamString ( const char *const  STR_Keyword, const Help &  CLI_Help  )

explicitprotected

Sub-classes constructor.

Parameters

STR_Keyword	Keyword.
CLI_Help	Corresponding help.

~ParamString()

virtual ParamString::~ParamString ( void  )

virtual

Destructor.

Member Function Documentation

Clone()

virtual const Param* const ParamString::Clone ( void  ) const

virtual

Parameter cloning handler.

Returns

A newly created parameter object of the correct type.

To be overloaded by derived classes.

Implements Param.

Reimplemented in ParamHost.

CopyValue()

virtual const Param& ParamString::CopyValue ( const Param &  CLI_Param ) const

virtual

Value copy handler.

Parameters

CLI_Param

Parameter to copy the value from.

Returns

The Param instance itself.

Implements Param.

operator const char *const()

ParamString::operator const char *const

(

void

)

const

Implicit cast operator.

SetstrValue()

virtual const bool ParamString::SetstrValue ( const char *const  STR_Value ) const

virtual

Value setting.

Parameters

STR_Value

New value.

Returns

true if the value has been set correctly, false otherwise.

To be overloaded by derived classes.

Implements Param.

---

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

• param_string.h