Sierra Toolkit Version of the Day
stk::diag::OptionDescription Struct Reference

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

#include <Option.hpp>

Inheritance diagram for stk::diag::OptionDescription:

List of all members.

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.

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

virtual stk::diag::OptionDescription::~OptionDescription ( ) [inline, virtual]

Destroys a OptionDescription instance.

Definition at line 24 of file Option.hpp.


Member Function Documentation

virtual std::ostream& stk::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::diag::Option, and stk::diag::OptionMaskParser.


The documentation for this struct was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines