Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | List of all members
ola::Flag< T > Class Template Reference

Detailed Description

template<typename T>
class ola::Flag< T >

A templated Flag class.

Template Parameters
Tthe type of the flag.
Inheritance diagram for ola::Flag< T >:
Inheritance graph
[legend]
Collaboration diagram for ola::Flag< T >:
Collaboration graph
[legend]

Public Member Functions

 Flag (const char *name, const char *arg_type, const char *short_opt, T default_value, const char *help, const bool has_arg)
 Create a new Flag. More...
 
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
 
Flagoperator= (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. More...
 
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. More...
 
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 >
ola::Flag< T >::Flag ( const char *  name,
const char *  arg_type,
const char *  short_opt,
default_value,
const char *  help,
const bool  has_arg 
)
inline

Create a new Flag.

Parameters
namethe name of the flag
arg_typethe type of flag argument
short_optthe short option for the flag
default_valuethe flag's default value
helpthe help string for the flag
has_argif the flag should use an argument, only overrides Flag<bool>

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