Manage a SNL command line option.
More...
#include <Options.h>
Manage a SNL command line option.
This class is designed to manage a single option parameter. An option is identified by an ID listed in _E_OPTIONS_ID. An option is identified by a keyword (OPTIONS_KEY), a value type (OPTIONS_TYPE) and a description (OPTIONS_DESC).
Then, option attributes can be specified:
- See also
- SnlProg
- Authors
- Florent Robinet, flore.nosp@m.nt.r.nosp@m.obine.nosp@m.t@ij.nosp@m.clab..nosp@m.in2p.nosp@m.3.fr
◆ SnlOpt()
Constructor of the SnlOpt class.
Default option attributes are set:
- Extra description = ""
- Value = 0
- Parameters
-
- See also
- _E_OPTIONS_ID
◆ ~SnlOpt()
Destructor of the SnlOpt class.
◆ GetId()
◆ GetValueD()
double SnlOpt::GetValueD |
( |
void |
| ) |
|
|
inline |
◆ GetValueI()
int SnlOpt::GetValueI |
( |
void |
| ) |
|
|
inline |
◆ GetValueS()
string SnlOpt::GetValueS |
( |
void |
| ) |
|
|
inline |
◆ GetValueUI()
unsigned int SnlOpt::GetValueUI |
( |
void |
| ) |
|
|
inline |
Returns the option value attribute (32-bit unsigned integer).
- See also
- _E_OPTIONS_TYPE.
◆ GetValueULI()
unsigned long int SnlOpt::GetValueULI |
( |
void |
| ) |
|
|
inline |
Returns the option value attribute (64-bit unsigned integer).
- See also
- _E_OPTIONS_TYPE.
◆ Print()
void SnlOpt::Print |
( |
void |
| ) |
|
◆ SetExtraDescription()
void SnlOpt::SetExtraDescription |
( |
const string |
aExtraDescription | ) |
|
|
inline |
Sets the option extra description attribute.
- Parameters
-
[in] | aExtraDescription | Extra description. |
- See also
- OPTIONS_DESC
◆ SetValue()
void SnlOpt::SetValue |
( |
const string |
aValue | ) |
|
Sets the option value attribute.
The input value is provided as a string variable. It is converted to the value type defined in _E_OPTIONS_TYPE.
- Parameters
-
◆ dvalue
◆ extra_description
string SnlOpt::extra_description |
|
private |
Extra description message.
◆ id
◆ ivalue
◆ svalue
◆ uivalue
unsigned int SnlOpt::uivalue |
|
private |
unsigned 32b integer value.
◆ ulivalue
unsigned long int SnlOpt::ulivalue |
|
private |
unsigned 64b integer value.
The documentation for this class was generated from the following files: