wibble::commandline::VectorOption< T > Class Template Reference

#include <options.h>

Inheritance diagram for wibble::commandline::VectorOption< T >:

Collaboration diagram for wibble::commandline::VectorOption< T >:

Public Member Functions
bool	boolValue () const
const std::vector< typename T::value_type > &	values () const
Public Member Functions inherited from wibble::commandline::Option
	Option ()
virtual	~Option ()
bool	isSet () const
const std::string &	name () const
void	addAlias (char c)
void	addAlias (const std::string &str)
const std::string &	fullUsage () const
	Return a full usage message including all the aliases for this option. More...
std::string	fullUsageForMan () const
Public Member Functions inherited from wibble::commandline::Managed
virtual	~Managed ()

Protected Member Functions
	VectorOption (const std::string &name)
	VectorOption (const std::string &name, char shortName, const std::string &longName, const std::string &usage=std::string(), const std::string &description=std::string())
ArgList::iterator	parse (ArgList &list, ArgList::iterator begin)
	Parse the next commandline parameter after the short form of the command has been found. More...
bool	parse (const std::string &param)
	Parse the commandline parameter of a long commandline switch. More...
void	parse_noarg ()
	Notify that the option is present in the command line, but has no arguments. More...
Protected Member Functions inherited from wibble::commandline::Option
	Option (const std::string &name)
	Option (const std::string &name, char shortName, const std::string &longName, const std::string &usage=std::string(), const std::string &description=std::string())
virtual ArgList::iterator	parse (ArgList &list, ArgList::iterator begin)=0
	Parse the next commandline parameter after the short form of the command has been found. More...
virtual bool	parse (const std::string &param)=0
	Parse the commandline parameter of a long commandline switch. More...
virtual void	parse_noarg ()=0
	Notify that the option is present in the command line, but has no arguments. More...
virtual bool	arg_is_optional () const
	Return true if the argument to this function can be omitted. More...

Friends
class	OptionGroup
class	Engine

Additional Inherited Members
Public Attributes inherited from wibble::commandline::Option
std::vector< char >	shortNames
std::vector< std::string >	longNames
std::string	usage
std::string	description
bool	hidden
Protected Attributes inherited from wibble::commandline::Option
bool	m_isset

Constructor & Destructor Documentation

VectorOption() [1/2]

template<typename T >

wibble::commandline::VectorOption< T >::VectorOption ( const std::string &  name )

inlineprotected

References wibble::commandline::Option::usage.

VectorOption() [2/2]

template<typename T >

wibble::commandline::VectorOption< T >::VectorOption ( const std::string &  name, char  shortName, const std::string &  longName, const std::string &  usage = std::string(), const std::string &  description = std::string()  )

inlineprotected

References wibble::commandline::Option::usage.

Member Function Documentation

boolValue()

template<typename T >

bool wibble::commandline::VectorOption< T >::boolValue ( ) const

inline

parse() [1/2]

template<typename T >

ArgList::iterator wibble::commandline::VectorOption< T >::parse ( ArgList &  list, ArgList::iterator  begin  )

inlineprotectedvirtual

Parse the next commandline parameter after the short form of the command has been found.

It may or may not remove the parameter from the list, depending on if the option wants a value or not.

Signal that the option has been found, with the given argument (or 0 if no argument).

Returns

true if it used the argument, else false

Implements wibble::commandline::Option.

References wibble::list::begin(), wibble::commandline::ArgList::eraseAndAdvance(), and wibble::commandline::Option::m_isset.

parse() [2/2]

template<typename T >

bool wibble::commandline::VectorOption< T >::parse ( const std::string &  param )

inlineprotectedvirtual

Parse the commandline parameter of a long commandline switch.

Returns

true if the parameter has been used

Implements wibble::commandline::Option.

References wibble::commandline::Option::m_isset.

parse_noarg()

template<typename T >

void wibble::commandline::VectorOption< T >::parse_noarg ( )

inlineprotectedvirtual

Notify that the option is present in the command line, but has no arguments.

Implements wibble::commandline::Option.

values()

template<typename T >

const std::vector< typename T::value_type > & wibble::commandline::VectorOption< T >::values ( ) const

inline

Friends And Related Function Documentation

Engine

template<typename T >

friend class Engine

friend

OptionGroup

template<typename T >

friend class OptionGroup

friend

---

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

• options.h