CLI  2.9
SyntaxRef Class Reference

Syntax tag reference element. More...

#include <syntax_tag.h>

Inheritance diagram for SyntaxRef:

Public Member Functions

 SyntaxRef (const SyntaxTag &CLI_Tag)
 Constructor. More...
 
virtual ~SyntaxRef (void)
 Destructor. More...
 
virtual const tk::String GetKeyword (void) const
 String identifier accessor. More...
 
const SyntaxTagGetTag (void) const
 Tag reference accessor. 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 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...
 
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 Object
 Object (void)
 Default constructor only available to sub-classes. More...
 

Detailed Description

Syntax tag reference element.

Definition at line 77 of file syntax_tag.h.

Constructor & Destructor Documentation

◆ SyntaxRef()

SyntaxRef::SyntaxRef ( const SyntaxTag CLI_Tag)
explicit

Constructor.

Parameters
CLI_TagReferenced tag element.

◆ ~SyntaxRef()

virtual SyntaxRef::~SyntaxRef ( void  )
virtual

Destructor.

Member Function Documentation

◆ GetKeyword()

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

String identifier accessor.

Returns
String identifier.

Reimplemented from Element.

◆ GetTag()

const SyntaxTag& SyntaxRef::GetTag ( void  ) const

Tag reference accessor.

Returns
Tag reference.

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