Defines a single option.
More...
#include <Options.h>
List of all members.
Public Member Functions |
| Option (std::string name, char shortName, std::string argument, Type type, Flag flags, std::string usage, CallBackFunc function, void *userPtr=NULL) |
| Construct an option.
|
template<typename T > |
| Option (std::string name, char shortName, std::string argument, Value< T > &value, std::string usage, CallBackFunc function, void *userPtr=NULL) |
| Construct an option from a Value.
|
| ~Option () |
Detailed Description
Defines a single option.
Definition at line 54 of file Options.h.
Member Typedef Documentation
typedef bool(* ArgusSamples::Options::Option::CallBackFunc)(void *usrPtr, const char *optArg) |
Call back function.
- Parameters:
-
[in] | usrPtr | user pointer |
[in] | optArg | optional argument string, NULL when there is no argument |
Definition at line 82 of file Options.h.
Member Enumeration Documentation
Argument flags.
- Enumerator:
FLAG_NO_ARGUMENT |
requires no argument
|
FLAG_OPTIONAL_ARGUMENT |
optionally takes an argument
|
FLAG_REQUIRED_ARGUMENT |
requires an argument
|
Definition at line 69 of file Options.h.
Type.
- Enumerator:
TYPE_ACTION |
triggers an action
|
TYPE_OPTION |
sets an option
|
Definition at line 60 of file Options.h.
Constructor & Destructor Documentation
ArgusSamples::Options::Option::Option |
( |
std::string |
name, |
|
|
char |
shortName, |
|
|
std::string |
argument, |
|
|
Type |
type, |
|
|
Flag |
flags, |
|
|
std::string |
usage, |
|
|
CallBackFunc |
function, |
|
|
void * |
userPtr = NULL |
|
) |
| |
|
inlineexplicit |
Construct an option.
- Parameters:
-
name | [in] long option name |
shortName | [in] short option name |
argument | [in] argument |
type | [in] option type |
flags | [in] flags |
usage | [in] a string describing the usage |
function | [in] callback function |
userPtr | [in] user pointer |
Definition at line 96 of file Options.h.
template<typename T >
ArgusSamples::Options::Option::Option |
( |
std::string |
name, |
|
|
char |
shortName, |
|
|
std::string |
argument, |
|
|
Value< T > & |
value, |
|
|
std::string |
usage, |
|
|
CallBackFunc |
function, |
|
|
void * |
userPtr = NULL |
|
) |
| |
|
inlineexplicit |
Construct an option from a Value.
The final usage string is build from the given usage and the default and valid values of the given value variable.
- Parameters:
-
name | [in] long option name |
shortName | [in] short option name |
argument | [in] argument |
value | [in] value to construct the option from |
usage | [in] a string describing the usage |
function | [in] callback function |
userPtr | [in] user pointer |
Definition at line 120 of file Options.h.
ArgusSamples::Options::Option::~Option |
( |
| ) |
|
|
inline |
Member Data Documentation
std::string ArgusSamples::Options::Option::m_argument |
Flag ArgusSamples::Options::Option::m_flags |
std::string ArgusSamples::Options::Option::m_name |
char ArgusSamples::Options::Option::m_shortName |
Type ArgusSamples::Options::Option::m_type |
std::string ArgusSamples::Options::Option::m_usage |
void* ArgusSamples::Options::Option::m_userPtr |
user pointer passed to callback function
Definition at line 147 of file Options.h.
The documentation for this class was generated from the following file: