The base class that manages the command line definition and passes along the parsing to the appropriate Arg classes. More...

#include <CmdLineInterface.h>

Inheritance diagram for TCLAP::CmdLineInterface:

[legend]

Collaboration diagram for TCLAP::CmdLineInterface:

[legend]

Public Member Functions
virtual	~CmdLineInterface ()
	Destructor.

virtual ArgContainer &	add (Arg &a)=0
	Adds an argument.

virtual ArgContainer &	add (Arg *a)=0
	Adds an argument.

virtual void	addToArgList (Arg *a)=0

virtual ArgContainer &	add (ArgGroup &args)=0
	Adds an argument group to the list of arguments to be parsed.

virtual void	xorAdd (Arg &a, Arg &b)=0

virtual void	xorAdd (const std::vector< Arg * > &xors)=0

virtual void	parse (int argc, const char const argv)=0
	Parses the command line.

void	parse (std::vector< std::string > &args)
	Parses the command line.

virtual void	setOutput (CmdLineOutput *co)=0

virtual std::string	getVersion () const =0
	Returns the version string.

virtual std::string	getProgramName () const =0
	Returns the program name string.

virtual std::list< ArgGroup * >	getArgGroups ()=0
	Returns the list of ArgGroups.

virtual std::list< Arg * >	getArgList () const =0

virtual char	getDelimiter () const =0
	Returns the delimiter string.

virtual std::string	getMessage () const =0
	Returns the message string.

virtual std::string	translateMessage (const std::string &messageId, const std::string &fallback) const =0
	Translates a built-in message using the current translator.

virtual bool	hasHelpAndVersion () const =0
	Indicates whether or not the help and version switches were created automatically.

virtual void	reset ()=0
	Resets the instance as if it had just been constructed so that the instance can be reused.

virtual void	beginIgnoring ()=0
	Begin ignoring arguments since the "--" argument was specified.

virtual bool	ignoreRest ()=0
	Whether to ignore the rest.

Public Member Functions inherited from TCLAP::ArgContainer
virtual	~ArgContainer ()

Protected Member Functions
virtual bool	attachGroup (ArgGroup &)

Friends
class	ArgGroup

Detailed Description

The base class that manages the command line definition and passes along the parsing to the appropriate Arg classes.

Definition at line 46 of file CmdLineInterface.h.

Constructor & Destructor Documentation

◆ ~CmdLineInterface()

virtual TCLAP::CmdLineInterface::~CmdLineInterface ( )

inlinevirtual

Destructor.

Definition at line 57 of file CmdLineInterface.h.

Member Function Documentation

◆ add() [1/3]

virtual ArgContainer & TCLAP::CmdLineInterface::add ( Arg & a )

pure virtual

Adds an argument.

Ownership is not transfered.

Parameters

a	- Argument to be added.

Return values

A	reference to this so that add calls can be chained

Implements TCLAP::ArgContainer.

Implemented in TCLAP::CmdLine.

Referenced by TCLAP::AnyOf::AnyOf(), TCLAP::ExclusiveArgGroup::ExclusiveArgGroup(), TCLAP::UnlabeledValueArg< T >::UnlabeledValueArg(), and TCLAP::UnlabeledValueArg< T >::UnlabeledValueArg().

◆ add() [2/3]

virtual ArgContainer & TCLAP::CmdLineInterface::add ( Arg * a )

pure virtual

Adds an argument.

Ownership is not transfered.

Parameters

a	- Argument to be added.

Return values

A	reference to this so that add calls can be chained

Implements TCLAP::ArgContainer.

Implemented in TCLAP::CmdLine.

◆ add() [3/3]

virtual ArgContainer & TCLAP::CmdLineInterface::add ( ArgGroup & args )

pure virtual

Adds an argument group to the list of arguments to be parsed.

All arguments in the group are added and the ArgGroup object will validate that the input matches its constraints.

Parameters

args	- Argument group to be added.

Return values

A	reference to this so that add calls can be chained

Implemented in TCLAP::CmdLine.

◆ addToArgList()

virtual void TCLAP::CmdLineInterface::addToArgList ( Arg * a )

pure virtual

Implemented in TCLAP::CmdLine.

Referenced by TCLAP::ArgGroup::add(), and TCLAP::ArgGroup::setParser().

◆ attachGroup()

virtual bool TCLAP::CmdLineInterface::attachGroup ( ArgGroup & )

inlineprotectedvirtual

Reimplemented in TCLAP::CmdLine.

Definition at line 51 of file CmdLineInterface.h.

Referenced by TCLAP::ArgGroup::setParser().

◆ beginIgnoring()

virtual void TCLAP::CmdLineInterface::beginIgnoring ( )

pure virtual

Begin ignoring arguments since the "--" argument was specified.

Implemented in TCLAP::CmdLine.

Referenced by TCLAP::IgnoreRestVisitor::visit().

◆ getArgGroups()

virtual std::list< ArgGroup * > TCLAP::CmdLineInterface::getArgGroups ( )

pure virtual

Returns the list of ArgGroups.

Implemented in TCLAP::CmdLine.

Referenced by TCLAP::StdOutput::_longUsage(), TCLAP::StdOutput::_shortUsage(), and TCLAP::DocBookOutput::usage().

◆ getArgList()

virtual std::list< Arg * > TCLAP::CmdLineInterface::getArgList ( ) const

pure virtual

Implemented in TCLAP::CmdLine.

Referenced by TCLAP::StdOutput::_longUsage(), TCLAP::StdOutput::_shortUsage(), and TCLAP::DocBookOutput::usage().

◆ getDelimiter()

virtual char TCLAP::CmdLineInterface::getDelimiter ( ) const

pure virtual

Returns the delimiter string.

Implemented in TCLAP::CmdLine.

Referenced by TCLAP::DocBookOutput::usage().

◆ getMessage()

virtual std::string TCLAP::CmdLineInterface::getMessage ( ) const

pure virtual

Returns the message string.

Implemented in TCLAP::CmdLine.

Referenced by TCLAP::StdOutput::_longUsage(), and TCLAP::DocBookOutput::usage().

◆ getProgramName()

virtual std::string TCLAP::CmdLineInterface::getProgramName ( ) const

pure virtual

Returns the program name string.

Implemented in TCLAP::CmdLine.

Referenced by TCLAP::StdOutput::_shortUsage(), TCLAP::StdOutput::failure(), TCLAP::DocBookOutput::usage(), and TCLAP::StdOutput::version().

◆ getVersion()

virtual std::string TCLAP::CmdLineInterface::getVersion ( ) const

pure virtual

Returns the version string.

Implemented in TCLAP::CmdLine.

Referenced by TCLAP::DocBookOutput::usage(), TCLAP::DocBookOutput::version(), and TCLAP::StdOutput::version().

◆ hasHelpAndVersion()

virtual bool TCLAP::CmdLineInterface::hasHelpAndVersion ( ) const

pure virtual

Indicates whether or not the help and version switches were created automatically.

Implemented in TCLAP::CmdLine.

Referenced by TCLAP::StdOutput::failure().

◆ ignoreRest()

virtual bool TCLAP::CmdLineInterface::ignoreRest ( )

pure virtual

Whether to ignore the rest.

Implemented in TCLAP::CmdLine.

◆ parse() [1/2]

virtual void TCLAP::CmdLineInterface::parse	(	int	argc,
		const char const	argv
	)

pure virtual

Parses the command line.

Parameters

argc	- Number of arguments.
argv	- Array of arguments.

Implemented in TCLAP::CmdLine.

◆ parse() [2/2]

void TCLAP::CmdLineInterface::parse ( std::vector< std::string > & args )

Parses the command line.

Parameters

args	- A vector of strings representing the args. args[0] is still the program name.

◆ reset()

virtual void TCLAP::CmdLineInterface::reset ( )

pure virtual

Resets the instance as if it had just been constructed so that the instance can be reused.

Implemented in TCLAP::CmdLine.

◆ setOutput()

virtual void TCLAP::CmdLineInterface::setOutput ( CmdLineOutput * co )

pure virtual

Parameters

co	- CmdLineOutput object that we want to use instead.

Implemented in TCLAP::CmdLine.

◆ translateMessage()

virtual std::string TCLAP::CmdLineInterface::translateMessage	(	const std::string &	messageId,
		const std::string &	fallback
	)		const

pure virtual

Translates a built-in message using the current translator.

Implemented in TCLAP::CmdLine.

Referenced by TCLAP::StdOutput::_longUsage(), TCLAP::StdOutput::failure(), TCLAP::StdOutput::usage(), and TCLAP::StdOutput::version().

◆ xorAdd() [1/2]

virtual void TCLAP::CmdLineInterface::xorAdd	(	Arg &	a,
		Arg &	b
	)

pure virtual

Deprecated:: Use OneOf instead.

Implemented in TCLAP::CmdLine.

◆ xorAdd() [2/2]

virtual void TCLAP::CmdLineInterface::xorAdd ( const std::vector< Arg * > & xors )

pure virtual

Deprecated:: Use OneOf instead.

Implemented in TCLAP::CmdLine.

Friends And Related Symbol Documentation

◆ ArgGroup

friend class ArgGroup

friend

Definition at line 47 of file CmdLineInterface.h.

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

CmdLineInterface.h

Public Member Functions

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ~CmdLineInterface()

Member Function Documentation

◆ add() [1/3]

◆ add() [2/3]

◆ add() [3/3]

◆ addToArgList()

◆ attachGroup()

◆ beginIgnoring()

◆ getArgGroups()

◆ getArgList()

◆ getDelimiter()

◆ getMessage()

◆ getProgramName()

◆ getVersion()

◆ hasHelpAndVersion()

◆ ignoreRest()

◆ parse() [1/2]

◆ parse() [2/2]

◆ reset()

◆ setOutput()

◆ translateMessage()

◆ xorAdd() [1/2]

◆ xorAdd() [2/2]

Friends And Related Symbol Documentation

◆ ArgGroup