theplu::yat::utility::OptionArg< T > Class Template Reference

Option with argument. More...

#include <yat/utility/OptionArg.h>

Inheritance diagram for theplu::yat::utility::OptionArg< T >:

Public Member Functions
	OptionArg (CommandLine &cmd, std::string name, std::string desc, bool required=false)
	Constructor. More...
void	print_arg (std::string arg)
T	value (void) const
void	value (T v)
	set value More...
std::string	description (void) const
void	description (const std::string &description)
	set description More...
std::string	long_name (void) const
void	parse (std::vector< std::string >::iterator &, const std::vector< std::string >::iterator &)
	parsing the commandline
bool	present (void) const
	Get if option was found in cmd. More...
std::string	print (void)
	print help output More...
void	reset (void)
	sets present to false
char	short_name (void) const
void	validate (void)
	Validate the Option. More...

Protected Member Functions
bool	required (void) const
const CommandLine &	cmd (void) const

Detailed Description

template<typename T>
class theplu::yat::utility::OptionArg< T >

Option with argument.

If the option is present, argument is set during parsing. Supported formats are both gnu-style "--support-gnu=value", POSIX-like "--support-posix value", as well as shorter "-s value". The argument of an parameter is retrived by the value() function. The type T should be either a string or a type supported by function convert().

Constructor & Destructor Documentation

OptionArg()

template<typename T>

theplu::yat::utility::OptionArg< T >::OptionArg ( CommandLine &  cmd, std::string  name, std::string  desc, bool  required = false  )

inline

Constructor.

Parameters

cmd	Commandline Option is associated with
name	string such as "help" for –help, "h" for -h or "h,help" for having both short and long option name
desc	string used in help display
required	If true option must be found in commandline or exception is thrown in validation

Member Function Documentation

cmd()

const CommandLine& theplu::yat::utility::Option::cmd ( void  ) const

protectedinherited

Returns

const reference to CommandLine Option belongs to.

description() [1/2]

std::string theplu::yat::utility::Option::description ( void  ) const

inherited

Returns

description

description() [2/2]

void theplu::yat::utility::Option::description ( const std::string &  description )

inherited

set description

Since

New in yat 0.7

long_name()

std::string theplu::yat::utility::Option::long_name ( void  ) const

inherited

Returns

long name e.g. 'help' for –help option.

present()

bool theplu::yat::utility::Option::present ( void  ) const

inherited

Get if option was found in cmd.

Returns

true if option has been detected in parsing

print()

std::string theplu::yat::utility::Option::print ( void  )

inherited

print help output

This function calls the four virtual private functions print1, print2, print3, and print4. This allows an inherited class to implement one (or several) of these functions and keep the default output of the others. The default behavior is that:

• print1 prints the short name, '-h', as short_name(void) const
• print2 prints the long name, '–help', as long_name(void) const
• print3 is empty
• print4 prints the description as description(void) const.

print_arg()

template<typename T>

void theplu::yat::utility::OptionArg< T >::print_arg ( std::string  arg )

inline

Parameters

arg	string to be used in help output such as '=TARGET' in '–target=TARGET'. See print3().

Since

New in yat 0.5.

required()

template<typename T>

bool theplu::yat::utility::OptionArg< T >::required ( void  ) const

inlineprotected

Returns

true if Option is required, i.e., if Option is not found during parsing an exception will be thrown.

short_name()

char theplu::yat::utility::Option::short_name ( void  ) const

inherited

Returns

short name e.g. 'h' for -h option.

validate()

void theplu::yat::utility::Option::validate ( void  )

inherited

Validate the Option.

This function is called by CommandLine::parse() after all options have been detected and parsed (see Option::parse()).

value() [1/2]

template<typename T>

T theplu::yat::utility::OptionArg< T >::value ( void  ) const

inline

Returns

value

value() [2/2]

template<typename T>

void theplu::yat::utility::OptionArg< T >::value ( T  v )

inline

set value

Since

new in yat 0.5

---

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

• yat/utility/OptionArg.h