stk::diag::OptionDescription Struct Reference

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

#include <WriterParser.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 15 of file WriterParser.hpp.

---

Constructor & Destructor Documentation

virtual stk::diag::OptionDescription::~OptionDescription

(

)

[inline, virtual]

Destroys a OptionDescription instance.

Definition at line 21 of file WriterParser.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:

os	a std::ostream reference to print to description to.

Returns:

a std::ostream reference to the output stream.

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

---

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

• WriterParser.hpp