A class that isolates any output from the CmdLine object so that it may be easily modified.
Definition at line 42 of file StdOutput.h.
#include <mrpt/otherlibs/tclap/StdOutput.h>
Public Member Functions | |
StdOutput (std::ostream &desired_out=std::cout) | |
Prints the usage to stdout. | |
virtual void | usage (CmdLineInterface &c) |
Prints the usage to stdout. | |
virtual void | version (CmdLineInterface &c) |
Prints the version to stdout. | |
virtual void | failure (CmdLineInterface &c, ArgException &e) |
Prints (to stderr) an error message, short usage Can be overridden to produce alternative behavior. | |
Protected Member Functions | |
void | _shortUsage (CmdLineInterface &c, std::ostream &os) const |
Writes a brief usage message with short args. | |
void | _longUsage (CmdLineInterface &c, std::ostream &os) const |
Writes a longer usage message with long and short args, provides descriptions and prints message. | |
void | spacePrint (std::ostream &os, const std::string &s, int maxWidth, int indentSpaces, int secondLineOffset) const |
This function inserts line breaks and indents long strings according the params input. | |
Protected Attributes | |
std::ostream & | m_my_output |
By JLBC for MRPT. |
TCLAP::StdOutput::StdOutput | ( | std::ostream & | desired_out = std::cout |
) | [inline] |
Prints the usage to stdout.
Can be overridden to produce alternative behavior.
c | - The CmdLine object the output is generated for. |
Definition at line 53 of file StdOutput.h.
void TCLAP::StdOutput::_longUsage | ( | CmdLineInterface & | c, | |
std::ostream & | os | |||
) | const [inline, protected] |
Writes a longer usage message with long and short args, provides descriptions and prints message.
c | - The CmdLine object the output is generated for. | |
os | - The stream to write the message to. |
Definition at line 198 of file StdOutput.h.
References begin(), TCLAP::XorHandler::contains(), end(), TCLAP::CmdLineInterface::getArgList(), TCLAP::CmdLineInterface::getMessage(), TCLAP::CmdLineInterface::getXorHandler(), TCLAP::XorHandler::getXorList(), and spacePrint().
Referenced by usage().
void TCLAP::StdOutput::_shortUsage | ( | CmdLineInterface & | c, | |
std::ostream & | os | |||
) | const [inline, protected] |
Writes a brief usage message with short args.
c | - The CmdLine object the output is generated for. | |
os | - The stream to write the message to. |
Definition at line 164 of file StdOutput.h.
References begin(), TCLAP::XorHandler::contains(), TCLAP::CmdLineInterface::getArgList(), TCLAP::CmdLineInterface::getProgramName(), TCLAP::CmdLineInterface::getXorHandler(), TCLAP::XorHandler::getXorList(), m_my_output, and spacePrint().
void TCLAP::StdOutput::failure | ( | CmdLineInterface & | c, | |
ArgException & | e | |||
) | [inline, virtual] |
Prints (to stderr) an error message, short usage Can be overridden to produce alternative behavior.
c | - The CmdLine object the output is generated for. | |
e | - The ArgException that caused the failure. |
Implements TCLAP::CmdLineOutput.
Definition at line 141 of file StdOutput.h.
References _shortUsage(), TCLAP::ArgException::argId(), TCLAP::ArgException::error(), TCLAP::CmdLineInterface::getProgramName(), TCLAP::CmdLineInterface::hasHelpAndVersion(), and usage().
void TCLAP::StdOutput::spacePrint | ( | std::ostream & | os, | |
const std::string & | s, | |||
int | maxWidth, | |||
int | indentSpaces, | |||
int | secondLineOffset | |||
) | const [inline, protected] |
This function inserts line breaks and indents long strings according the params input.
It will only break lines at spaces, commas and pipes.
os | - The stream to be printed to. | |
s | - The string to be printed. | |
maxWidth | - The maxWidth allowed for the output line. | |
indentSpaces | - The number of spaces to indent the first line. | |
secondLineOffset | - The number of spaces to indent the second and all subsequent lines in addition to indentSpaces. |
Definition at line 236 of file StdOutput.h.
Referenced by _longUsage(), and _shortUsage().
void TCLAP::StdOutput::usage | ( | CmdLineInterface & | c | ) | [inline, virtual] |
Prints the usage to stdout.
Can be overridden to produce alternative behavior.
c | - The CmdLine object the output is generated for. |
Implements TCLAP::CmdLineOutput.
Definition at line 127 of file StdOutput.h.
References _longUsage(), _shortUsage(), and m_my_output.
Referenced by failure().
void TCLAP::StdOutput::version | ( | CmdLineInterface & | c | ) | [inline, virtual] |
Prints the version to stdout.
Can be overridden to produce alternative behavior.
c | - The CmdLine object the output is generated for. |
Implements TCLAP::CmdLineOutput.
Definition at line 118 of file StdOutput.h.
References TCLAP::CmdLineInterface::getProgramName(), TCLAP::CmdLineInterface::getVersion(), and m_my_output.
std::ostream& TCLAP::StdOutput::m_my_output [protected] |
By JLBC for MRPT.
Definition at line 45 of file StdOutput.h.
Referenced by _shortUsage(), usage(), and version().
Page generated by Doxygen 1.7.1 for MRPT 0.9.4 SVN: at Mon Jan 10 23:33:19 UTC 2011 |