CLI  2.9
TraceClass Class Reference

Trace class object. More...

#include <traces.h>

Inheritance diagram for TraceClass:

Public Types

typedef tk::Queue< TraceClassList
 Trace class list typedef. More...
 

Public Member Functions

 TraceClass (const TraceClass &CLI_Class)
 Copy constructor. More...
 
 TraceClass (const char *const STR_ClassName, const Help &CLI_Help)
 Constructor. More...
 
virtual ~TraceClass (void)
 Destructor. More...
 
const tk::String GetName (void) const
 Class name accessor. More...
 
const HelpGetHelp (void) const
 Description accessor. More...
 
TraceClassoperator= (const TraceClass &)
 Assignment operator. 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

Trace class object.

Definition at line 51 of file traces.h.

Member Typedef Documentation

◆ List

typedef tk::Queue<TraceClass> TraceClass::List

Trace class list typedef.

Returns
N/A (doxygen warning)

Definition at line 56 of file traces.h.

Constructor & Destructor Documentation

◆ TraceClass() [1/2]

TraceClass::TraceClass ( const TraceClass CLI_Class)

Copy constructor.

Parameters
CLI_ClassSource class object.

◆ TraceClass() [2/2]

TraceClass::TraceClass ( const char *const  STR_ClassName,
const Help CLI_Help 
)
explicit

Constructor.

Parameters
STR_ClassNameClass name.
CLI_HelpHelp description.

◆ ~TraceClass()

virtual TraceClass::~TraceClass ( void  )
virtual

Destructor.

Member Function Documentation

◆ GetHelp()

const Help& TraceClass::GetHelp ( void  ) const

Description accessor.

Returns
Trace class description.

◆ GetName()

const tk::String TraceClass::GetName ( void  ) const

Class name accessor.

Returns
Class name.

◆ operator=()

TraceClass& TraceClass::operator= ( const TraceClass )

Assignment operator.

Returns
The TraceClass instance itself.

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