TCLAP::CmdLineOutput Class Reference

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

#include <CmdLineOutput.h>

Inheritance diagram for TCLAP::CmdLineOutput:

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

Detailed Description

The interface that any output object must implement.

Definition at line 44 of file CmdLineOutput.h.

Constructor & Destructor Documentation

~CmdLineOutput()

virtual TCLAP::CmdLineOutput::~CmdLineOutput ( )

inlinevirtual

Virtual destructor.

Definition at line 52 of file CmdLineOutput.h.

References failure(), usage(), and version().

Here is the call graph for this function:

Member Function Documentation

failure()

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::ZshCompletionOutput, TCLAP::DocBookOutput, and TCLAP::StdOutput.

Referenced by TCLAP::CmdLine::parse(), and ~CmdLineOutput().

usage()

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::ZshCompletionOutput, TCLAP::DocBookOutput, and TCLAP::StdOutput.

Referenced by ~CmdLineOutput().

version()

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::ZshCompletionOutput, TCLAP::DocBookOutput, and TCLAP::StdOutput.

Referenced by ~CmdLineOutput().

---

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

• CmdLineOutput.h