Public Member Functions | List of all members
ecl::CmdLineOutput Class Referenceabstract

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

#include <cmd_line_output.hpp>

Inheritance diagram for ecl::CmdLineOutput:
Inheritance graph
[legend]

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 37 of file cmd_line_output.hpp.

Constructor & Destructor Documentation

◆ ~CmdLineOutput()

virtual ecl::CmdLineOutput::~CmdLineOutput ( )
inlinevirtual

Virtual destructor.

Definition at line 45 of file cmd_line_output.hpp.

Member Function Documentation

◆ failure()

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

◆ usage()

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

◆ version()

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


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


ecl_command_line
Author(s): Daniel Stonier
autogenerated on Sun Aug 2 2020 03:12:03