CLI  2.9
ParamHost Class Reference

Host names, IP adresses parameter element class. More...

#include <param_host.h>

Inheritance diagram for ParamHost:

Public Member Functions

 ParamHost (const Help &CLI_Help)
 Constructor. More...
 
virtual ~ParamHost (void)
 Destructor. More...
 
virtual const Param *const Clone (void) const
 Parameter cloning handler. More...
 
- Public Member Functions inherited from ParamString
 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 ParamCopyValue (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...
 
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...
 
ElementAddElement (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 HelpGetHelp (void) const
 Element help accessor. More...
 
virtual void SetCli (Cli &CLI_Cli)
 Cli reference setting. More...
 
CliGetCli (void)
 Read-Write Cli reference accessor. More...
 
const CliGetCli (void) const
 Read-only Cli reference accessor. More...
 
ShellGetShell (void) const
 Shell reference accessor. More...
 
const OutputDeviceGetOutputStream (void) const
 Output stream reference accessor. More...
 
const OutputDeviceGetErrorStream (void) const
 Error stream reference accessor. More...
 
- Public Member Functions inherited from Object
virtual ~Object (void)=0
 Pure virtual destructor. 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...
 
- Protected Member Functions inherited from ParamString
 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...
 

Detailed Description

Host names, IP adresses parameter element class.

Definition at line 46 of file param_host.h.

Constructor & Destructor Documentation

◆ ParamHost()

ParamHost::ParamHost ( const Help CLI_Help)
explicit

Constructor.

Parameters
CLI_HelpCorresponding help.

◆ ~ParamHost()

virtual ParamHost::~ParamHost ( void  )
virtual

Destructor.

Member Function Documentation

◆ Clone()

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

Parameter cloning handler.

Returns
A newly created parameter object of the correct type.

To be overloaded by derived classes.

Reimplemented from ParamString.


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