Main MRPT website > C++ reference for MRPT 1.4.0
List of all members | Public Member Functions | Protected Member Functions | Protected Attributes
TCLAP::StdOutput Class Reference

Detailed Description

A class that isolates any output from the CmdLine object so that it may be easily modified.

Definition at line 50 of file StdOutput.h.

#include <mrpt/otherlibs/tclap/StdOutput.h>

Inheritance diagram for TCLAP::StdOutput:
Inheritance graph

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...
 

Constructor & Destructor Documentation

◆ StdOutput()

TCLAP::StdOutput::StdOutput ( std::ostream &  desired_out = std::cout)
inline

Prints the usage to stdout.

Can be overridden to produce alternative behavior.

Parameters
c- The CmdLine object the output is generated for.

Definition at line 61 of file StdOutput.h.

Member Function Documentation

◆ _longUsage()

void TCLAP::StdOutput::_longUsage ( CmdLineInterface c,
std::ostream &  os 
) const
inlineprotected

Writes a longer usage message with long and short args, provides descriptions and prints message.

Parameters
c- The CmdLine object the output is generated for.
os- The stream to write the message to.

Definition at line 206 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().

◆ _shortUsage()

void TCLAP::StdOutput::_shortUsage ( CmdLineInterface c,
std::ostream &  os 
) const
inlineprotected

Writes a brief usage message with short args.

Parameters
c- The CmdLine object the output is generated for.
os- The stream to write the message to.

Definition at line 172 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().

Referenced by failure(), and usage().

◆ failure()

void TCLAP::StdOutput::failure ( CmdLineInterface c,
ArgException e 
)
inlinevirtual

Prints (to stderr) an error message, short usage Can be overridden to produce alternative behavior.

Parameters
c- The CmdLine object the output is generated for.
e- The ArgException that caused the failure.

Implements TCLAP::CmdLineOutput.

Definition at line 149 of file StdOutput.h.

References _shortUsage(), TCLAP::ArgException::argId(), TCLAP::ArgException::error(), TCLAP::CmdLineInterface::getProgramName(), TCLAP::CmdLineInterface::hasHelpAndVersion(), and usage().

◆ spacePrint()

void TCLAP::StdOutput::spacePrint ( std::ostream &  os,
const std::string &  s,
int  maxWidth,
int  indentSpaces,
int  secondLineOffset 
) const
inlineprotected

This function inserts line breaks and indents long strings according the params input.

It will only break lines at spaces, commas and pipes.

Parameters
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 244 of file StdOutput.h.

Referenced by _longUsage(), and _shortUsage().

◆ usage()

void TCLAP::StdOutput::usage ( CmdLineInterface c)
inlinevirtual

Prints the usage to stdout.

Can be overridden to produce alternative behavior.

Parameters
c- The CmdLine object the output is generated for.

Implements TCLAP::CmdLineOutput.

Definition at line 135 of file StdOutput.h.

References _longUsage(), _shortUsage(), and m_my_output.

Referenced by failure().

◆ version()

void TCLAP::StdOutput::version ( CmdLineInterface c)
inlinevirtual

Prints the version to stdout.

Can be overridden to produce alternative behavior.

Parameters
c- The CmdLine object the output is generated for.

Implements TCLAP::CmdLineOutput.

Definition at line 126 of file StdOutput.h.

References TCLAP::CmdLineInterface::getProgramName(), TCLAP::CmdLineInterface::getVersion(), and m_my_output.

Member Data Documentation

◆ m_my_output

std::ostream& TCLAP::StdOutput::m_my_output
protected

By JLBC for MRPT.

Definition at line 53 of file StdOutput.h.

Referenced by _shortUsage(), usage(), and version().




Page generated by Doxygen 1.9.1 for MRPT 1.4.0 SVN: at Sun Mar 7 18:43:46 UTC 2021