Detailed Description

a string flag

Inheritance diagram for ola::Flag< std::string >:

Collaboration diagram for ola::Flag< std::string >:

Public Member Functions
	Flag (const char name, const char arg_type, const char short_opt, std::string default_value, const char help, const bool has_arg)
const char *	name () const
	Get the flag name.
bool	has_arg () const
	Whether the flag requires an argument.
std::string	default_value () const
const char *	arg_type () const
	Get the flag argument type.
	operator const char * () const
	operator std::string () const
std::string	str () const
Flag &	operator= (const std::string &v)
bool	SetValue (const std::string &input)
	Set the flag value.
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.
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)

Member Function Documentation

bool ola::Flag< std::string >::SetValue ( const std::string & input )

inlinevirtual

Set the flag value.

Parameters

input the input passed on the command line

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