Single option. More...

#include <GwollumOptions.h>

Public Member Functions
void	Add (const double aValue)
	Adds the option value (double).

void	Add (const int aValue)
	Adds an option value (int).

void	Add (const string aValue)
	Adds the option value (string).

void	Add (const unsigned int aValue)
	Adds the option value (unsigned int).

double	GetDefaultD (void)
	Returns the option default value (double).

int	GetDefaultI (void)
	Returns the option default value (int).

string	GetDefaultS (void)
	Returns the option default value (string).

unsigned int	GetDefaultU (void)
	Returns the option default value (unsigned int).

string	GetKey (void)
	Returns the option key.

unsigned int	GetNumberOfValues (void)
	Returns the number of values.

string	GetOptionName (const unsigned int aValIndex)
	Returns a codified option name.

unsigned int	GetSize (void)
	Returns the option size.

string	GetTag (void)
	Returns the option tag.

char	GetType (void)
	Returns the option type.

double	GetValueD (const unsigned int aValIndex=0)
	Returns the option value (double).

bool	GetValueD (double &aValue, const unsigned int aValIndex)
	Returns the option value (double).

int	GetValueI (const unsigned int aValIndex=0)
	Returns the option value (int).

bool	GetValueI (int &aValue, const unsigned int aValIndex)
	Returns the option value (int).

string	GetValueS (const unsigned int aValIndex=0)
	Returns the option value (string).

bool	GetValueS (string &aValue, const unsigned int aValIndex)
	Returns the option value (string).

vector< double >	GetValuesD (void)
	Returns the list of option values (double).

vector< int >	GetValuesI (void)
	Returns the list of option values (int).

vector< string >	GetValuesS (void)
	Returns the list of option values (string).

vector< unsigned int >	GetValuesU (void)
	Returns the list of option values (unsigned int).

unsigned int	GetValueU (const unsigned int aValIndex=0)
	Returns the option value (unsigned int).

bool	GetValueU (unsigned int &aValue, const unsigned int aValIndex)
	Returns the option value (unsigned int).

bool	IsProvided (void)
	Tests whether an option value was provided.

void	Reset (void)
	Resets the option.

void	Set (const unsigned int aValIndex, const double aValue)
	Updates an option value (double).

void	Set (const unsigned int aValIndex, const int aValue)
	Updates an option value (int).

void	Set (const unsigned int aValIndex, const string aValue)
	Updates an option value (string).

void	Set (const unsigned int aValIndex, const unsigned int aValue)
	Updates an option value (unsigned int).

void	SetDefault (void)
	Set option to default values.

Constructors and destructors
	GwollumOption (const string aTag, const string aKey, const int aDefaultValue, const unsigned int aSize=0)
	Constructor of the GwollumOption class (int).

	GwollumOption (const string aTag, const string aKey, const unsigned int aDefaultValue, const unsigned int aSize=0)
	Constructor of the GwollumOption class (unsigned int).

	GwollumOption (const string aTag, const string aKey, const double aDefaultValue, const unsigned int aSize=0)
	Constructor of the GwollumOption class (double).

	GwollumOption (const string aTag, const string aKey, const string aDefaultValue, const unsigned int aSize=0)
	Constructor of the GwollumOption class (string).

virtual	~GwollumOption (void)
	Destructor of the GwollumOption class.

Private Attributes
double	ddef
	Option double default value.

vector< double >	dvec
	Option double vector.

int	idef
	Option integer default value.

vector< int >	ivec
	Option integer vector.

string	key
	Option key.

unsigned int	osize
	Option size (number of fixed values).

bool	provided
	Set to true if the option was explicitly given.

string	sdef
	Option string default value.

vector< string >	svec
	Option string vector.

string	tag
	Option tag.

unsigned int	udef
	Option unsigned integer default value.

vector< unsigned int >	uvec
	Option unsigned integer vector.

char	valtype
	Option value type.

Detailed Description

Single option.

A single option is defined by:

A TAG string
A KEY string
A type: int (i), unsigned int (u), double (d), string (s)
A size: an option can be given a fixed size. Use 0 for an option with a variable size.
A default value
A list of values

Constructor & Destructor Documentation

◆ GwollumOption() [1/4]

GwollumOption::GwollumOption	(	const string	aTag,
		const string	aKey,
		const int	aDefaultValue,
		const unsigned int	aSize = `0`
	)

Constructor of the GwollumOption class (int).

The option is uniquely identified by a TAG and a KEY string. It is given a default value. It is possible to fix the number of values for the option. If the size is equal to 0, the number of values is not fixed.

Parameters

[in]	aTag	Option tag. Do not use "_"; they will be removed.
[in]	aKey	Option aKey. Do not use "_"; they will be removed.
[in]	aDefaultValue	Default value.
[in]	aSize	Number of values for this option. Use 0 for a variable size.

◆ GwollumOption() [2/4]

GwollumOption::GwollumOption	(	const string	aTag,
		const string	aKey,
		const unsigned int	aDefaultValue,
		const unsigned int	aSize = `0`
	)

Constructor of the GwollumOption class (unsigned int).

The option is uniquely identified by a TAG and a KEY string. It is given a default value. It is possible to fix the number of values for the option. If the size is equal to 0, the number of values is not fixed.

Parameters

[in]	aTag	Option tag. Do not use "_"; they will be removed.
[in]	aKey	Option aKey. Do not use "_"; they will be removed.
[in]	aDefaultValue	Default value.
[in]	aSize	Number of values for this option. Use 0 for a variable size.

◆ GwollumOption() [3/4]

GwollumOption::GwollumOption	(	const string	aTag,
		const string	aKey,
		const double	aDefaultValue,
		const unsigned int	aSize = `0`
	)

Constructor of the GwollumOption class (double).

The option is uniquely identified by a TAG and a KEY string. It is given a default value. It is possible to fix the number of values for the option. If the size is equal to 0, the number of values is not fixed.

Parameters

[in]	aTag	Option tag. Do not use "_"; they will be removed.
[in]	aKey	Option aKey. Do not use "_"; they will be removed.
[in]	aDefaultValue	Default value.
[in]	aSize	Number of values for this option. Use 0 for a variable size.

◆ GwollumOption() [4/4]

GwollumOption::GwollumOption	(	const string	aTag,
		const string	aKey,
		const string	aDefaultValue,
		const unsigned int	aSize = `0`
	)

Constructor of the GwollumOption class (string).

The option is uniquely identified by a TAG and a KEY string. It is given a default value. It is possible to fix the number of values for the option. If the size is equal to 0, the number of values is not fixed.

Parameters

[in]	aTag	Option tag. Do not use "_"; they will be removed.
[in]	aKey	Option aKey. Do not use "_"; they will be removed.
[in]	aDefaultValue	Default value.
[in]	aSize	Number of values for this option. Use 0 for a variable size.

◆ ~GwollumOption()

GwollumOption::~GwollumOption ( void )

virtual

Destructor of the GwollumOption class.

Member Function Documentation

◆ Add() [1/4]

void GwollumOption::Add ( const double aValue )

inline

Adds the option value (double).

Appends the value to the list of option values.

Warning: This function only works for variable-size options. Use the Set() function for fixed-sized options.

Parameters

[in] aValue Option value.

◆ Add() [2/4]

void GwollumOption::Add ( const int aValue )

inline

Adds an option value (int).

Appends the value to the list of option values.

Warning: This function only works for variable-size options. Use the Set() function for fixed-sized options.

Parameters

[in] aValue Option value.

◆ Add() [3/4]

void GwollumOption::Add ( const string aValue )

inline

Adds the option value (string).

Appends the value to the list of option values.

Warning: This function only works for variable-size options. Use the Set() function for fixed-sized options.

Parameters

[in] aValue Option value.

◆ Add() [4/4]

void GwollumOption::Add ( const unsigned int aValue )

inline

Adds the option value (unsigned int).

Appends the value to the list of option values.

Warning: This function only works for variable-size options. Use the Set() function for fixed-sized options.

Parameters

[in] aValue Option value.

◆ GetDefaultD()

double GwollumOption::GetDefaultD ( void )

inline

Returns the option default value (double).

◆ GetDefaultI()

int GwollumOption::GetDefaultI ( void )

inline

Returns the option default value (int).

◆ GetDefaultS()

string GwollumOption::GetDefaultS ( void )

inline

Returns the option default value (string).

◆ GetDefaultU()

unsigned int GwollumOption::GetDefaultU ( void )

inline

Returns the option default value (unsigned int).

◆ GetKey()

string GwollumOption::GetKey ( void )

inline

Returns the option key.

◆ GetNumberOfValues()

unsigned int GwollumOption::GetNumberOfValues ( void )

inline

Returns the number of values.

◆ GetOptionName()

string GwollumOption::GetOptionName ( const unsigned int aValIndex )

Returns a codified option name.

The option name is codified: [TAG]_[KEY]_[INDEX]_[SIZE]:

[TAG]: option tag word.
[KEY]: option key word.
[INDEX]: option value index.
[SIZE]: option size (0 for variable option).

Parameters

[in] aValIndex Option value index.

◆ GetSize()

unsigned int GwollumOption::GetSize ( void )

inline

Returns the option size.

Returns: 0 for variable-size options. Use GetNumberOfValues() to get the actual number of option values.

◆ GetTag()

string GwollumOption::GetTag ( void )

inline

Returns the option tag.

◆ GetType()

char GwollumOption::GetType ( void )

inline

Returns the option type.

◆ GetValueD() [1/2]

double GwollumOption::GetValueD ( const unsigned int aValIndex = 0 )

inline

Returns the option value (double).

Warning: Only call this function for double options!

Parameters

[in] aValIndex Option index.

Returns: The default value if the index is out of range.

◆ GetValueD() [2/2]

bool GwollumOption::GetValueD	(	double &	aValue,
		const unsigned int	aValIndex
	)

inline

Returns the option value (double).

Warning: Only call this function for double options!

Returns: true if the value exists, false otherwise.

Parameters

[out]	aValue	Returned value.
[in]	aValIndex	Value index.

◆ GetValueI() [1/2]

int GwollumOption::GetValueI ( const unsigned int aValIndex = 0 )

inline

Returns the option value (int).

Warning: Only call this function for int options!

Parameters

[in] aValIndex Value index.

Returns: The default value if the index is out of range.

◆ GetValueI() [2/2]

bool GwollumOption::GetValueI	(	int &	aValue,
		const unsigned int	aValIndex
	)

inline

Returns the option value (int).

Warning: Only call this function for int options!

Returns: true if the value exists, false otherwise.

Parameters

[out]	aValue	Returned value.
[in]	aValIndex	Value index.

◆ GetValueS() [1/2]

string GwollumOption::GetValueS ( const unsigned int aValIndex = 0 )

inline

Returns the option value (string).

Warning: Only call this function for string options!

Parameters

[in] aValIndex Option index.

Returns: The default value if the index is out of range.

◆ GetValueS() [2/2]

bool GwollumOption::GetValueS	(	string &	aValue,
		const unsigned int	aValIndex
	)

inline

Returns the option value (string).

Warning: Only call this function for string options!

Returns: true if the value exists, false otherwise.

Parameters

[out]	aValue	Returned value.
[in]	aValIndex	Value index.

◆ GetValuesD()

vector< double > GwollumOption::GetValuesD ( void )

inline

Returns the list of option values (double).

Warning: Only call this function for double options!

◆ GetValuesI()

vector< int > GwollumOption::GetValuesI ( void )

inline

Returns the list of option values (int).

Warning: Only call this function for int options!

◆ GetValuesS()

vector< string > GwollumOption::GetValuesS ( void )

inline

Returns the list of option values (string).

Warning: Only call this function for string options!

◆ GetValuesU()

vector< unsigned int > GwollumOption::GetValuesU ( void )

inline

Returns the list of option values (unsigned int).

Warning: Only call this function for unsigned int options!

◆ GetValueU() [1/2]

unsigned int GwollumOption::GetValueU ( const unsigned int aValIndex = 0 )

inline

Returns the option value (unsigned int).

Warning: Only call this function for unsigned int options!

Parameters

[in] aValIndex Option index.

Returns: The default value if the index is out of range.

◆ GetValueU() [2/2]

bool GwollumOption::GetValueU	(	unsigned int &	aValue,
		const unsigned int	aValIndex
	)

inline

Returns the option value (unsigned int).

Warning: Only call this function for unsigned int options!

Returns: true if the value exists, false otherwise.

Parameters

[out]	aValue	Returned value.
[in]	aValIndex	Value index.

◆ IsProvided()

bool GwollumOption::IsProvided ( void )

inline

Tests whether an option value was provided.

This applies if at least one value was provided with Set() or Add().

Returns: true if this is the case.

◆ Reset()

void GwollumOption::Reset ( void )

Resets the option.

All the option values are removed. Fixed-size option values are set to default. Variable-size options are simply empty.

◆ Set() [1/4]

void GwollumOption::Set	(	const unsigned int	aValIndex,
		const double	aValue
	)

inline

Updates an option value (double).

Parameters

[in]	aValIndex	Option index.
[in]	aValue	Option value.

◆ Set() [2/4]

void GwollumOption::Set	(	const unsigned int	aValIndex,
		const int	aValue
	)

inline

Updates an option value (int).

Parameters

[in]	aValIndex	Option index.
[in]	aValue	Option value.

◆ Set() [3/4]

void GwollumOption::Set	(	const unsigned int	aValIndex,
		const string	aValue
	)

inline

Updates an option value (string).

Parameters

[in]	aValIndex	Option index.
[in]	aValue	Option value.

◆ Set() [4/4]

void GwollumOption::Set	(	const unsigned int	aValIndex,
		const unsigned int	aValue
	)

inline

Updates an option value (unsigned int).

Parameters

[in]	aValIndex	Option index.
[in]	aValue	Option value.

◆ SetDefault()

void GwollumOption::SetDefault ( void )

Set option to default values.

For fixed-size options, all values are set to default. For variable-size options, the option is given one single value set to default.

Member Data Documentation

◆ ddef

double GwollumOption::ddef

private

Option double default value.

◆ dvec

vector<double> GwollumOption::dvec

private

Option double vector.

◆ idef

int GwollumOption::idef

private

Option integer default value.

◆ ivec

vector<int> GwollumOption::ivec

private

Option integer vector.

◆ key

string GwollumOption::key

private

Option key.

◆ osize

unsigned int GwollumOption::osize

private

Option size (number of fixed values).

◆ provided

bool GwollumOption::provided

private

Set to true if the option was explicitly given.

◆ sdef

string GwollumOption::sdef

private

Option string default value.

◆ svec

vector<string> GwollumOption::svec

private

Option string vector.

◆ tag

string GwollumOption::tag

private

Option tag.

◆ udef

unsigned int GwollumOption::udef

private

Option unsigned integer default value.

◆ uvec

vector<unsigned int> GwollumOption::uvec

private

Option unsigned integer vector.

◆ valtype

char GwollumOption::valtype

private

Option value type.

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

src/Utils/GwollumOptions.h
src/Utils/GwollumOptions.cc

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GwollumOption() [1/4]

◆ GwollumOption() [2/4]

◆ GwollumOption() [3/4]

◆ GwollumOption() [4/4]

◆ ~GwollumOption()

Member Function Documentation

◆ Add() [1/4]

◆ Add() [2/4]

◆ Add() [3/4]

◆ Add() [4/4]

◆ GetDefaultD()

◆ GetDefaultI()

◆ GetDefaultS()

◆ GetDefaultU()

◆ GetKey()

◆ GetNumberOfValues()

◆ GetOptionName()

◆ GetSize()

◆ GetTag()

◆ GetType()

◆ GetValueD() [1/2]

◆ GetValueD() [2/2]

◆ GetValueI() [1/2]

◆ GetValueI() [2/2]

◆ GetValueS() [1/2]

◆ GetValueS() [2/2]

◆ GetValuesD()

◆ GetValuesI()

◆ GetValuesS()

◆ GetValuesU()

◆ GetValueU() [1/2]

◆ GetValueU() [2/2]

◆ IsProvided()

◆ Reset()

◆ Set() [1/4]

◆ Set() [2/4]

◆ Set() [3/4]

◆ Set() [4/4]

◆ SetDefault()

Member Data Documentation

◆ ddef

◆ dvec

◆ idef

◆ ivec

◆ key

◆ osize

◆ provided

◆ sdef

◆ svec

◆ tag

◆ udef

◆ uvec

◆ valtype