Sierra Toolkit  Version of the Day
stk_classic::diag::OptionDescription Struct Referenceabstract

Class OptionDescription is an interface class for describing a command line option or option value. More...

#include <Option.hpp>

Inheritance diagram for stk_classic::diag::OptionDescription:

Public Member Functions

virtual ~OptionDescription ()
 
virtual std::ostream & describe (std::ostream &os) const =0
 Member function describe prints a description of the option to the stream. More...
 

Detailed Description

Class OptionDescription is an interface class for describing a command line option or option value.

Definition at line 18 of file Option.hpp.

Constructor & Destructor Documentation

◆ ~OptionDescription()

virtual stk_classic::diag::OptionDescription::~OptionDescription ( )
inlinevirtual

Destroys a OptionDescription instance.

Definition at line 24 of file Option.hpp.

Member Function Documentation

◆ describe()

virtual std::ostream& stk_classic::diag::OptionDescription::describe ( std::ostream &  os) const
pure virtual

Member function describe prints a description of the option to the stream.

Parameters
osa std::ostream reference to print to description to.
Returns
a std::ostream reference to the output stream.

Implemented in stk_classic::diag::OptionMaskParser, and stk_classic::diag::Option.


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