Element Class Reference

Generic CLI element. More...

#include <element.h>

Inheritance diagram for Element:

Public Types
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...

Public Member Functions
	Element (const char *const STR_Keyword, const Help &STR_Help)
	Constructor. More...
virtual	~Element (void)=0
	Destructor. More...
virtual const tk::String	GetKeyword (void) const
	String identifier accessor. More...
virtual const Help &	GetHelp (void) const
	Element help 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 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...

Additional Inherited Members
Protected Member Functions inherited from Object
	Object (void)
	Default constructor only available to sub-classes. More...

Detailed Description

Generic CLI element.

This class describes a generic CLI element (keywords, parameters, menus...). It basically contains a keyword i.e. an string identifier, and a help object.

Definition at line 55 of file element.h.

Member Typedef Documentation

List

typedef tk::Queue<const Element*> Element::List

CLI element list type.

Returns

N/A (doxygen warning)

Definition at line 61 of file element.h.

Map

typedef tk::Map<const tk::String, const Element*> Element::Map

CLI element map type.

Returns

N/A (doxygen warning)

Definition at line 64 of file element.h.

Constructor & Destructor Documentation

Element()

Element::Element ( const char *const  STR_Keyword, const Help &  STR_Help  )

explicit

Constructor.

Parameters

STR_Keyword	String identifier.
STR_Help	Help.

~Element()

virtual Element::~Element ( void  )

pure virtual

Destructor.

Pure virtual. Element is not final.

Member Function Documentation

FindElements()

virtual const bool Element::FindElements ( Element::List &  CLI_ExactList, Element::List &  CLI_NearList, const char *const  STR_Keyword  ) const

virtual

Sub-elements search.

Parameters

CLI_ExactList	Output list of elements exactly matching STR_Keyword.
CLI_NearList	Output list of elements matching STR_Keyword exactly or not.
STR_Keyword	Keyword or beginning of a keyword. Can be the whole word, or just the beginning, or something possibly matching (for parameters). NULL means no keyword begun. Put NULL to retrieve all sub-elements.

Returns

true for success, false otherwise.

Reimplemented in SyntaxNode, and Param.

GetCli() [1/2]

Cli& Element::GetCli

(

void

)

Read-Write Cli reference accessor.

Returns

Read-Write Cli reference.

GetCli() [2/2]

const Cli& Element::GetCli

(

void

)

const

Read-only Cli reference accessor.

Returns

Read-only Cli reference.

GetErrorStream()

const OutputDevice& Element::GetErrorStream

(

void

)

const

Error stream reference accessor.

Returns

Error stream reference.

GetHelp()

virtual const Help& Element::GetHelp ( void  ) const

virtual

Element help accessor.

Returns

Element help member reference.

GetKeyword()

virtual const tk::String Element::GetKeyword ( void  ) const

virtual

String identifier accessor.

Returns

String identifier.

Reimplemented in SyntaxRef, Param, and SyntaxTag.

GetOutputStream()

const OutputDevice& Element::GetOutputStream

(

void

)

const

Output stream reference accessor.

Returns

Output stream reference.

GetShell()

Shell& Element::GetShell

(

void

)

const

Shell reference accessor.

Returns

Shell reference.

Note

Returns a read-write Shell reference even though the element may be read-only.

SetCli()

virtual void Element::SetCli ( Cli &  CLI_Cli )

virtual

Cli reference setting.

Parameters

CLI_Cli

Cli reference.

The m_pcliCli member should be set for each Element object. However, generally, this method is automaticaly called, as in SyntaxNode::AddElement() for instance.

Reimplemented in Cli, Menu, ConfigMenu, and TracesMenu.

---

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

• element.h