ecl::CmdLineOutput Class Reference

Tclap class indirectly used by children for standardising outputs. More...

#include <cmd_line_output.hpp>

Inheritance diagram for ecl::CmdLineOutput:

[legend]

List of all members.

Public Member Functions
virtual void	failure (CmdLineInterface &c, ArgException &e)=0
virtual void	usage (CmdLineInterface &c)=0
virtual void	version (CmdLineInterface &c)=0
virtual	~CmdLineOutput ()

---

Detailed Description

Tclap class indirectly used by children for standardising outputs.

The interface that any output object must implement.

Definition at line 35 of file cmd_line_output.hpp.

---

Constructor & Destructor Documentation

virtual ecl::CmdLineOutput::~CmdLineOutput

(

)

[inline, virtual]

Virtual destructor.

Definition at line 43 of file cmd_line_output.hpp.

---

Member Function Documentation

virtual void ecl::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 ecl::DocBookOutput, and ecl::StdOutput.

virtual void ecl::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 ecl::DocBookOutput, and ecl::StdOutput.

virtual void ecl::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 ecl::DocBookOutput, and ecl::StdOutput.

---

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

• cmd_line_output.hpp