TCLAP::CmdLineOutput Class Reference

The interface that any output object must implement. More...

#include <CmdLineOutput.h>

Inheritance diagram for TCLAP::CmdLineOutput:
TCLAP::DocBookOutput TCLAP::StdOutput TCLAP::ZshCompletionOutput

List of all members.

Public Member Functions

virtual  ~CmdLineOutput ()
  Virtual destructor.
virtual void  usage (CmdLineInterface &c)=0
  Generates some sort of output for the USAGE.
virtual void  version (CmdLineInterface &c)=0
  Generates some sort of output for the version.
virtual void  failure (CmdLineInterface &c, ArgException &e)=0
  Generates some sort of output for a failure.

Detailed Description

The interface that any output object must implement.

Definition at line 41 of file CmdLineOutput.h.


Constructor & Destructor Documentation

virtual TCLAP::CmdLineOutput::~CmdLineOutput (  )  [inline, virtual]

Virtual destructor.

Definition at line 49 of file CmdLineOutput.h.


Member Function Documentation

virtual void TCLAP::CmdLineOutput::failure ( CmdLineInterface c,
ArgException e  
) [pure virtual]

Generates some sort of output for a failure.

Parameters:
c  - The CmdLine object the output is generated for.
e  - The ArgException that caused the failure.

Implemented in TCLAP::DocBookOutput, TCLAP::StdOutput, and TCLAP::ZshCompletionOutput.

Referenced by TCLAP::CmdLine::parse().

virtual void TCLAP::CmdLineOutput::usage ( CmdLineInterface c  )  [pure virtual]

Generates some sort of output for the USAGE.

Parameters:
c  - The CmdLine object the output is generated for.

Implemented in TCLAP::DocBookOutput, TCLAP::StdOutput, and TCLAP::ZshCompletionOutput.

virtual void TCLAP::CmdLineOutput::version ( CmdLineInterface c  )  [pure virtual]

Generates some sort of output for the version.

Parameters:
c  - The CmdLine object the output is generated for.

Implemented in TCLAP::DocBookOutput, TCLAP::StdOutput, and TCLAP::ZshCompletionOutput.


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

Generated on Sat Apr 16 15:34:25 2011 for tclap by  doxygen 1.6.0