A class that isolates any output from the CmdLine object so that it may be easily modified.
Definition at line 66 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. More... | |
virtual void | usage (CmdLineInterface &c) |
Prints the usage to stdout. More... | |
virtual void | version (CmdLineInterface &c) |
Prints the version to stdout. More... | |
virtual void | failure (CmdLineInterface &c, ArgException &e) |
Prints (to stderr) an error message, short usage Can be overridden to produce alternative behavior. More... | |
Protected Member Functions | |
void | _shortUsage (CmdLineInterface &c, std::ostream &os) const |
Writes a brief usage message with short args. More... | |
void | _longUsage (CmdLineInterface &c, std::ostream &os) const |
Writes a longer usage message with long and short args, provides descriptions and prints message. More... | |
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. More... | |
Protected Attributes | |
std::ostream & | m_my_output |
By JLBC for MRPT. More... | |
|
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 94 of file StdOutput.h.
|
inlineprotected |
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 222 of file StdOutput.h.
|
inlineprotected |
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 188 of file StdOutput.h.
Referenced by usage().
|
inlinevirtual |
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 165 of file StdOutput.h.
|
inlineprotected |
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 260 of file StdOutput.h.
|
inlinevirtual |
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 151 of file StdOutput.h.
References _shortUsage(), TCLAP::ArgException::argId(), TCLAP::ArgException::error(), TCLAP::CmdLineInterface::getProgramName(), and TCLAP::CmdLineInterface::hasHelpAndVersion().
|
inlinevirtual |
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 142 of file StdOutput.h.
|
protected |
By JLBC for MRPT.
Definition at line 86 of file StdOutput.h.
Page generated by Doxygen 1.8.16 for MRPT 1.4.0 SVN: at Mon Oct 14 22:32:58 UTC 2019 |