TCLAP Namespace Reference

Classes
class	Arg
	A virtual base class that defines the essential data for all arguments. More...
class	ArgException
	A simple class that defines and argument exception. More...
class	ArgParseException
	Thrown from within the child Arg classes when it fails to properly parse the argument it has been passed. More...
class	CmdLineParseException
	Thrown from CmdLine when the arguments on the command line are not properly specified, e.g. More...
class	SpecificationException
	Thrown from Arg and CmdLine when an Arg is improperly specified, e.g. More...
class	CmdLine
	The base class that manages the command line definition and passes along the parsing to the appropriate Arg classes. More...
class	CmdLineInterface
	The base class that manages the command line definition and passes along the parsing to the appropriate Arg classes. More...
class	HelpVisitor
	A Visitor object that calls the usage method of a given CmdLine. More...
class	IgnoreRestVisitor
	A Vistor that tells the CmdLine to begin ignoring arguments after this one is parsed. More...
class	MultiArg
	An argument that allows multiple values of type T to be specified. More...
class	SwitchArg
	A simple switch argument. More...
class	UnlabeledMultiArg
	Just like a MultiArg, except that the arguments are unlabeled. More...
class	UnlabeledValueArg
	The basic unlabeled argument that parses a value. More...
class	ValueArg
	The basic labeled argument that parses a value. More...
class	VersionVisitor
	A Vistor that will call the version method of the given CmdLine and then exit. More...
class	Visitor
	A base class that defines the interface for visitors. More...
class	XorHandler
	This class handles lists of Arg's that are to be XOR'd on the command line. More...
Namespaces
namespace	MULTI_ARG_HELPER
namespace	VALUE_ARG_HELPER
Typedefs
typedef std::list< Arg * >::iterator	ArgIterator
	Typedef of a list iterator.
typedef std::vector< Arg * >::iterator	ArgVectorIterator
Functions
void	spacePrint (std::ostream &os, const std::string &s, int maxWidth, int indentSpaces=0, int secondLineOffset=0)
	This function inserts line breaks and indents long strings according the params input.

---

Typedef Documentation

typedef std::list<Arg*>::iterator TCLAP::ArgIterator

Typedef of a list iterator.

typedef std::vector<Arg*>::iterator TCLAP::ArgVectorIterator

---

Function Documentation

void TCLAP::spacePrint	(	std::ostream &	os,
		const std::string &	s,
		int	maxWidth,
		int	indentSpaces = 0,
		int	secondLineOffset = 0
	)			[inline]

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.

---