Detailed Description

A templated Flag class.

Template Parameters

T	the type of the flag.

Inheritance diagram for ola::Flag< T >:

Public Member Functions
	Flag (const char name, const char arg_type, const char short_opt, T default_value, const char help, OLA_UNUSED const bool has_arg)
	Create a new Flag.
const char *	name () const
	Get the flag name.
bool	has_arg () const
	Whether the flag requires an argument.
bool	default_value () const
	operator T () const
Flag &	operator= (T v)
bool	SetValue (const std::string &input)
	Used to set the value of a flag.
Public Member Functions inherited from ola::BaseFlag
	BaseFlag (const char arg_type, const char short_opt, const char *help)
	Create a new BaseFlag.
char	short_opt () const
	Get the flag short option.
const char *	arg_type () const
	Get the flag argument type.
std::string	help () const
	Get the flag help string.
bool	present () const
	Check if the flag was present on the command line. Good for switching behaviour when a flag is used.
void	MarkAsPresent ()
	Set that the flag was present on the command line.

Additional Inherited Members
Protected Member Functions inherited from ola::BaseFlag
void	ReplaceUnderscoreWithHyphen (char *input)
const char *	NewCanonicalName (const char *name)

Constructor & Destructor Documentation

template<typename T >

inline

Create a new Flag.

Parameters

name	the name of the flag
arg_type	the type of flag argument
short_opt	the short option for the flag
default_value	the flag's default value
help	the help string for the flag
has_arg	if the flag should use an argument, only overrides Flag<bool>

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