Describe the value of an option passed to a program. More...

#include <OptionValue.h>

Public Member Functions
void	addValue (const std::string &value)
	Add value of the OptionValue. More...

void	bashCompletionValue (std::string &strBashCompletion, const std::string &cursorOption) const
	Print the possible value to the bash completion. More...

VecValue &	getDefaultValue ()

const VecValue &	getDefaultValue () const
	Get the default value of the OptionValue. More...

VecValue &	getPossibleValue ()

const VecValue &	getPossibleValue () const
	Get the possible values of the OptionValue. More...

OptionType::OptionType &	getType ()

OptionType::OptionType	getType () const
	Get the type of the OptionValue. More...

VecValue &	getValue ()

const VecValue &	getValue () const
	Get the vector of values. More...

template<typename T >
void	getValue (std::list< T > &vecValue, bool isParsed) const
	Get the value of the option. More...

template<typename T >
void	getValue (std::vector< T > &vecValue, bool isParsed) const
	Get the value of the option. More...

template<typename T >
void	getValue (T &value, bool isParsed) const
	Get the value of the option. More...

OptionValue &	operator= (const OptionValue &other)
	Definition of equal operator of OptionValue. More...

	OptionValue (const OptionValue &other)
	Copy constructor of OptionValue. More...

	OptionValue (const std::string &value, OptionType::OptionType type, const VecValue &vecDefaultValue)
	Initialisation function of the class OptionValue. More...

	OptionValue (const std::string &value, OptionType::OptionType type, const VecValue &vecDefaultValue, const VecValue &vecPossibleValue)
	Initialisation function of the class OptionValue. More...

	OptionValue (const std::string &value, OptionType::OptionType type=OptionType::STRING)
	Initialisation function of the class OptionValue. More...

	OptionValue (const VecValue &vecValue, OptionType::OptionType type, const VecValue &vecDefaultValue)
	Initialisation function of the class OptionValue. More...

	OptionValue (const VecValue &vecValue, OptionType::OptionType type, const VecValue &vecDefaultValue, const VecValue &vecPossibleValue)
	Initialisation function of the class OptionValue. More...

	OptionValue (const VecValue &vecValue, OptionType::OptionType type=OptionType::STRING)
	Initialisation function of the class OptionValue. More...

	OptionValue (OptionType::OptionType type=OptionType::STRING)
	Default constructeur of OptionValue. More...

template<typename T >
void	setDefaultValue (const std::list< T > &value)
	Set the value in the OptionValue. More...

template<typename T >
void	setDefaultValue (const std::vector< T > &value)
	Set the value in the OptionValue. More...

template<typename T >
void	setDefaultValue (const T &value)
	Set the value in the OptionValue. More...

void	setType (OptionType::OptionType type)
	Set the type of the OptionValue. More...

void	setValue (const std::string &value)
	Set the value of the OptionValue. More...

void	setValue (const VecValue &value)
	Set the value of the OptionValue. More...

virtual	~OptionValue ()
	Destructeur of OptionValue. More...

Protected Member Functions
void	copyOptionValue (const OptionValue &other)
	Copy function of OptionValue. More...

Private Member Functions
template<typename T >
void	checkTypeFromTemplate () const
	Check the type from the template. More...

void	initialisationOptionValue (const VecValue &vecValue, OptionType::OptionType type, const VecValue &vecDefaultValue, const VecValue &vecPossibleValue)
	Initialisation function of the class OptionValue. More...

Private Attributes
OptionType::OptionType	p_type
	Type of the OptionValue. More...

VecValue	p_vecDefaultValue
	Default value of the OptionValue. More...

VecValue	p_vecPossibleValue
	Vector of the possible value for the OptionValue. More...

VecValue	p_vecValue
	Vector of the values of the OptionValue. More...

Detailed Description

Describe the value of an option passed to a program.

Definition at line 20 of file OptionValue.h.

Constructor & Destructor Documentation

◆ OptionValue() [1/8]

OptionValue::OptionValue ( OptionType::OptionType type = OptionType::STRING )

Default constructeur of OptionValue.

Parameters

type	: type of the OptionValue

Definition at line 13 of file OptionValue.cpp.

                                                  {
         VecValue vecValue, vecDefaultValue, vecPossibleValue;
         initialisationOptionValue(vecValue, type, vecDefaultValue, vecPossibleValue);
 }

References initialisationOptionValue(), and createReleaseCurl::type.

Here is the call graph for this function:

◆ OptionValue() [2/8]

OptionValue::OptionValue	(	const std::string &	value,
		OptionType::OptionType	type = `OptionType::STRING`
	)

Initialisation function of the class OptionValue.

Parameters

value	: value of the OptionValue
type	: type of the OptionValue

Definition at line 22 of file OptionValue.cpp.

                                                                           {
         VecValue vecValue, vecDefaultValue, vecPossibleValue;
         vecValue.push_back(value);
         initialisationOptionValue(vecValue, type, vecDefaultValue, vecPossibleValue);
 }

References initialisationOptionValue(), and createReleaseCurl::type.

Here is the call graph for this function:

◆ OptionValue() [3/8]

OptionValue::OptionValue	(	const VecValue &	vecValue,
		OptionType::OptionType	type = `OptionType::STRING`
	)

Initialisation function of the class OptionValue.

Parameters

vecValue	: vector of values of the OptionValue
type	: type of the OptionValue

Definition at line 32 of file OptionValue.cpp.

                                                                             {
         VecValue vecDefaultValue, vecPossibleValue;
         initialisationOptionValue(vecValue, type, vecDefaultValue, vecPossibleValue);
 }

References initialisationOptionValue(), and createReleaseCurl::type.

Here is the call graph for this function:

◆ OptionValue() [4/8]

OptionValue::OptionValue	(	const std::string &	value,
		OptionType::OptionType	type,
		const VecValue &	vecDefaultValue
	)

Initialisation function of the class OptionValue.

Parameters

value	: value of the OptionValue
type	: type of the OptionValue
vecDefaultValue	: default value of the OptionValue

Definition at line 42 of file OptionValue.cpp.

                                                                                                             {
         VecValue vecValue, vecPossibleValue;
         vecValue.push_back(value);
         initialisationOptionValue(vecValue, type, vecDefaultValue, vecPossibleValue);
 }

References initialisationOptionValue(), and createReleaseCurl::type.

Here is the call graph for this function:

◆ OptionValue() [5/8]

OptionValue::OptionValue	(	const VecValue &	vecValue,
		OptionType::OptionType	type,
		const VecValue &	vecDefaultValue
	)

Initialisation function of the class OptionValue.

Parameters

vecValue	: vector of values of the OptionValue
type	: type of the OptionValue
vecDefaultValue	: default value of the OptionValue

Definition at line 53 of file OptionValue.cpp.

                                                                                                               {
         VecValue vecPossibleValue;
         initialisationOptionValue(vecValue, type, vecDefaultValue, vecPossibleValue);
 }

References initialisationOptionValue(), and createReleaseCurl::type.

Here is the call graph for this function:

◆ OptionValue() [6/8]

OptionValue::OptionValue	(	const std::string &	value,
		OptionType::OptionType	type,
		const VecValue &	vecDefaultValue,
		const VecValue &	vecPossibleValue
	)

Initialisation function of the class OptionValue.

Parameters

value	: value of the OptionValue
type	: type of the OptionValue
vecDefaultValue	: default value of the OptionValue
vecPossibleValue	: vector of the possible values for the OptionValue

Definition at line 64 of file OptionValue.cpp.

                                                                                                                                                {
         VecValue vecValue;
         vecValue.push_back(value);
         initialisationOptionValue(vecValue, type, vecDefaultValue, vecPossibleValue);
 }

References initialisationOptionValue(), and createReleaseCurl::type.

Here is the call graph for this function:

◆ OptionValue() [7/8]

OptionValue::OptionValue	(	const VecValue &	vecValue,
		OptionType::OptionType	type,
		const VecValue &	vecDefaultValue,
		const VecValue &	vecPossibleValue
	)

Initialisation function of the class OptionValue.

Parameters

vecValue	: vector of values of the OptionValue
type	: type of the OptionValue
vecDefaultValue	: default value of the OptionValue
vecPossibleValue	: vector of the possible values for the OptionValue

Definition at line 76 of file OptionValue.cpp.

                                                                                                                                                  {
         initialisationOptionValue(vecValue, type, vecDefaultValue, vecPossibleValue);
 }

References initialisationOptionValue(), and createReleaseCurl::type.

Here is the call graph for this function:

◆ OptionValue() [8/8]

OptionValue::OptionValue ( const OptionValue & other )

Copy constructor of OptionValue.

Parameters

other : class to copy

Definition at line 84 of file OptionValue.cpp.

                                                  {
         copyOptionValue(other);
 }

References copyOptionValue().

Here is the call graph for this function:

◆ ~OptionValue()

OptionValue::~OptionValue ( )

virtual

Destructeur of OptionValue.

Definition at line 89 of file OptionValue.cpp.

                          {
         
 }

Member Function Documentation

◆ addValue()

void OptionValue::addValue ( const std::string & value )

Add value of the OptionValue.

Parameters

value : value to be added

Definition at line 126 of file OptionValue.cpp.

126 {p_vecValue.push_back(value);}

References p_vecValue.

Referenced by Option::parsePartOption().

Here is the caller graph for this function:

◆ bashCompletionValue()

void OptionValue::bashCompletionValue	(	std::string &	strBashCompletion,
		const std::string &	cursorOption
	)		const

Print the possible value to the bash completion.

Parameters

[out]	strBashCompletion	: string of all possible choices
	cursorOption	: option of the cursor which is currently completed

Definition at line 172 of file OptionValue.cpp.

                                                                                                         {
 //      std::cerr << "OptionValue::bashCompletionValue : cursorOption = '"<<cursorOption<<"'" << std::endl;
         if(p_vecPossibleValue.size() != 0lu){   //If there is some possible values, we print them
                 for(VecValue::const_iterator it(p_vecPossibleValue.begin()); it != p_vecPossibleValue.end(); ++it){
                         strBashCompletion += " " + *it;
                 }
         }else{
                 //Now, we can complete by respect to the expected type
                 if(p_type == OptionType::FILE_OR_DIR || p_type == OptionType::FILENAME){
                         strBashCompletion += path_completion_all(cursorOption);
                 }else if(p_type == OptionType::DIRECTORY){
                         strBashCompletion += path_completion_dirOnly(cursorOption);
                 }else{
                         strBashCompletion += convertOptionTypeToString(p_type);
                 }
         }
 }

References convertOptionTypeToString(), OptionType::DIRECTORY, OptionType::FILE_OR_DIR, OptionType::FILENAME, p_type, p_vecPossibleValue, path_completion_all(), and path_completion_dirOnly().

Referenced by Option::getPossibleValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkTypeFromTemplate()

template<typename T >

void OptionValue::checkTypeFromTemplate

private

Check the type from the template.

Throw exception if there is an incompatibility

Definition at line 105 of file OptionValue_impl.h.

                                              {
         OptionType::OptionType optionTypeFromDefault = getOptionTypeFromType<T>();
         if(!isOptionTypeCompatible(p_type, optionTypeFromDefault)){
                 std::stringstream strError;
                 strError << "OptionValue::checkTypeFromTemplate : Incompatible types from parameters (" << convertOptionTypeToString(p_type) << ") ad for default type ("<<convertOptionTypeToString(optionTypeFromDefault)<<")";
                 throw std::runtime_error(strError.str());
         }
 }

References convertOptionTypeToString(), isOptionTypeCompatible(), and p_type.

Here is the call graph for this function:

◆ copyOptionValue()

void OptionValue::copyOptionValue ( const OptionValue & other )

protected

Copy function of OptionValue.

Parameters

other : class to copy

Definition at line 193 of file OptionValue.cpp.

                                                           {
         p_vecValue = other.p_vecValue;
         p_type = other.p_type;
         p_vecDefaultValue = other.p_vecDefaultValue;
         p_vecPossibleValue = other.p_vecPossibleValue;
 }

References p_type, p_vecDefaultValue, p_vecPossibleValue, and p_vecValue.

Referenced by operator=(), and OptionValue().

Here is the caller graph for this function:

◆ getDefaultValue() [1/2]

VecValue& OptionValue::getDefaultValue ( )

◆ getDefaultValue() [2/2]

VecValue & OptionValue::getDefaultValue ( ) const

Get the default value of the OptionValue.

Returns: default value of the OptionValue

Definition at line 151 of file OptionValue.cpp.

151 {return p_vecDefaultValue;}

References p_vecDefaultValue.

Referenced by Option::print(), printValueOfOpt(), and testOptionValue().

Here is the caller graph for this function:

◆ getPossibleValue() [1/2]

VecValue& OptionValue::getPossibleValue ( )

◆ getPossibleValue() [2/2]

VecValue & OptionValue::getPossibleValue ( ) const

Get the possible values of the OptionValue.

Returns: possible values of the OptionValue

Definition at line 161 of file OptionValue.cpp.

161 {return p_vecPossibleValue;}

References p_vecPossibleValue.

Referenced by Option::print(), printValueOfOpt(), and testOptionValue().

Here is the caller graph for this function:

◆ getType() [1/2]

OptionType::OptionType& OptionValue::getType ( )

◆ getType() [2/2]

OptionType::OptionType & OptionValue::getType ( ) const

Get the type of the OptionValue.

Returns: type of the OptionValue

Definition at line 141 of file OptionValue.cpp.

141 {return p_type;}

References p_type.

Referenced by Option::checkArgument(), Option::parsePartOption(), and Option::print().

Here is the caller graph for this function:

◆ getValue() [1/5]

VecValue& OptionValue::getValue ( )

◆ getValue() [2/5]

VecValue & OptionValue::getValue ( ) const

Get the vector of values.

Returns: vector of values

Definition at line 131 of file OptionValue.cpp.

131 {return p_vecValue;}

References p_vecValue.

Referenced by OptionMode::getValue(), printValueOfOpt(), printValueOfOptConst(), and testOptionValue().

Here is the caller graph for this function:

◆ getValue() [3/5]

template<typename T >

void OptionValue::getValue	(	std::list< T > &	vecValue,
		bool	isParsed
	)		const

Get the value of the option.

Parameters

[out]	vecValue	: value of the option
	isParsed	: true if the option is parsed, false if not

Definition at line 88 of file OptionValue_impl.h.

                                                                     {
         checkTypeFromTemplate<T>();
         if(isParsed){
                 for(VecValue::const_iterator it(p_vecValue.begin()); it != p_vecValue.end(); ++it){
                         vecValue.push_back(stringToValue<T>(*it));
                 }
         }else{
                 for(VecValue::const_iterator it(p_vecDefaultValue.begin()); it != p_vecDefaultValue.end(); ++it){
                         vecValue.push_back(stringToValue<T>(*it));
                 }
         }
 }

References p_vecDefaultValue, and p_vecValue.

◆ getValue() [4/5]

template<typename T >

void OptionValue::getValue	(	std::vector< T > &	vecValue,
		bool	isParsed
	)		const

Get the value of the option.

Parameters

[out]	vecValue	: value of the option
	isParsed	: true if the option is parsed, false if not

Definition at line 70 of file OptionValue_impl.h.

                                                                       {
         checkTypeFromTemplate<T>();
         if(isParsed){
                 for(VecValue::const_iterator it(p_vecValue.begin()); it != p_vecValue.end(); ++it){
                         vecValue.push_back(stringToValue<T>(*it));
                 }
         }else{
                 for(VecValue::const_iterator it(p_vecDefaultValue.begin()); it != p_vecDefaultValue.end(); ++it){
                         vecValue.push_back(stringToValue<T>(*it));
                 }
         }
 }

References p_vecDefaultValue, and p_vecValue.

◆ getValue() [5/5]

template<typename T >

void OptionValue::getValue	(	T &	value,
		bool	isParsed
	)		const

Get the value of the option.

Parameters

[out]	value	: value of the option
	isParsed	: true if the option is parsed, false if not

Definition at line 49 of file OptionValue_impl.h.

                                                         {
         checkTypeFromTemplate<T>();
         if(isParsed){
                 if(p_vecValue.size() > 1lu){
                         std::runtime_error("OptionValue::getValue : several value but only one value in parameter");
                 }
                 value = stringToValue<T>(p_vecValue.front());
         }else{
                 if(p_vecDefaultValue.size() == 1lu){
                         value = stringToValue<T>(p_vecDefaultValue.front());
                 }else{
                         std::runtime_error("OptionValue::getValue : several value but only one value in parameter");
                 }
         }
 }

References p_vecDefaultValue, and p_vecValue.

◆ initialisationOptionValue()

void OptionValue::initialisationOptionValue	(	const VecValue &	vecValue,
		OptionType::OptionType	type,
		const VecValue &	vecDefaultValue,
		const VecValue &	vecPossibleValue
	)

private

Initialisation function of the class OptionValue.

Parameters

vecValue	: vector of values of the OptionValue
type	: type of the OptionValue
vecDefaultValue	: default value of the OptionValue
vecPossibleValue	: vector of the possible values for the OptionValue

Definition at line 206 of file OptionValue.cpp.

                                                                                                                                                                     {
         p_vecValue = vecValue;
         p_type = type;
         p_vecDefaultValue = vecDefaultValue;
         p_vecPossibleValue = vecPossibleValue;
 }

References p_type, p_vecDefaultValue, p_vecPossibleValue, p_vecValue, and createReleaseCurl::type.

Referenced by OptionValue().

Here is the caller graph for this function:

◆ operator=()

OptionValue & OptionValue::operator= ( const OptionValue & other )

Definition of equal operator of OptionValue.

Parameters

other : class to copy

Returns: copied class

Definition at line 97 of file OptionValue.cpp.

                                                                {
         copyOptionValue(other);
         return *this;
 }

References copyOptionValue().

Here is the call graph for this function:

◆ setDefaultValue() [1/3]

template<typename T >

void OptionValue::setDefaultValue ( const std::list< T > & value )

Set the value in the OptionValue.

Parameters

value : value of the OptionValue

Definition at line 36 of file OptionValue_impl.h.

                                                          {
         VecValue vecValue;
         for(typename std::list<T>::const_iterator it(value.begin()); it != value.end(); ++it){
                 vecValue.push_back(convertToString(*it));
         }
         p_vecDefaultValue = vecValue;
 }

References convertToString(), and p_vecDefaultValue.

Here is the call graph for this function:

◆ setDefaultValue() [2/3]

template<typename T >

void OptionValue::setDefaultValue ( const std::vector< T > & value )

Set the value in the OptionValue.

Parameters

value : value of the OptionValue

Definition at line 28 of file OptionValue_impl.h.

                                                            {
         p_vecDefaultValue = value;
 }

References p_vecDefaultValue.

◆ setDefaultValue() [3/3]

template<typename T >

void OptionValue::setDefaultValue ( const T & value )

Set the value in the OptionValue.

Parameters

value : value of the OptionValue

Definition at line 17 of file OptionValue_impl.h.

                                                 {
         std::string valueBinStr(convertToString(value));
         VecValue vecValue;
         vecValue.push_back(valueBinStr);
         p_vecDefaultValue = vecValue;
 }

References convertToString(), and p_vecDefaultValue.

Referenced by OptionParser::addOption().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setType()

void OptionValue::setType ( OptionType::OptionType type )

Set the type of the OptionValue.

Parameters

type	: type of the OptionValue

Definition at line 105 of file OptionValue.cpp.

                                                   {
         p_type = type;
 }

References p_type, and createReleaseCurl::type.

Referenced by OptionParser::addOption().

Here is the caller graph for this function:

◆ setValue() [1/2]

void OptionValue::setValue ( const std::string & value )

Set the value of the OptionValue.

Parameters

value : value to be set

Definition at line 112 of file OptionValue.cpp.

                                                  {
         VecValue vecValue;
         vecValue.push_back(value);
         setValue(vecValue);
 }

Referenced by testOptionValue().

Here is the caller graph for this function:

◆ setValue() [2/2]

void OptionValue::setValue ( const VecValue & value )

Set the value of the OptionValue.

Parameters

value : value to be set

Definition at line 121 of file OptionValue.cpp.

121 {p_vecValue = value;}

References p_vecValue.

Member Data Documentation

◆ p_type

OptionType::OptionType OptionValue::p_type

private

Type of the OptionValue.

Definition at line 77 of file OptionValue.h.

Referenced by bashCompletionValue(), checkTypeFromTemplate(), copyOptionValue(), getType(), initialisationOptionValue(), and setType().

◆ p_vecDefaultValue

VecValue OptionValue::p_vecDefaultValue

private

Default value of the OptionValue.

Definition at line 81 of file OptionValue.h.

Referenced by copyOptionValue(), getDefaultValue(), getValue(), initialisationOptionValue(), and setDefaultValue().

◆ p_vecPossibleValue

VecValue OptionValue::p_vecPossibleValue

private

Vector of the possible value for the OptionValue.

Definition at line 83 of file OptionValue.h.

Referenced by bashCompletionValue(), copyOptionValue(), getPossibleValue(), and initialisationOptionValue().

◆ p_vecValue

VecValue OptionValue::p_vecValue

private

Vector of the values of the OptionValue.

Definition at line 79 of file OptionValue.h.

Referenced by addValue(), copyOptionValue(), getValue(), initialisationOptionValue(), and setValue().

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

/builds/CTA-LAPP/PHOENIX_LIBS/PhoenixMock/tmp_project/OptionParser/src/OptionValue.h
/builds/CTA-LAPP/PHOENIX_LIBS/PhoenixMock/tmp_project/OptionParser/src/OptionValue.cpp
/builds/CTA-LAPP/PHOENIX_LIBS/PhoenixMock/tmp_project/OptionParser/src/OptionValue_impl.h

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ OptionValue() [1/8]

◆ OptionValue() [2/8]

◆ OptionValue() [3/8]

◆ OptionValue() [4/8]

◆ OptionValue() [5/8]

◆ OptionValue() [6/8]

◆ OptionValue() [7/8]

◆ OptionValue() [8/8]

◆ ~OptionValue()

Member Function Documentation

◆ addValue()

◆ bashCompletionValue()

◆ checkTypeFromTemplate()

◆ copyOptionValue()

◆ getDefaultValue() [1/2]

◆ getDefaultValue() [2/2]

◆ getPossibleValue() [1/2]

◆ getPossibleValue() [2/2]

◆ getType() [1/2]

◆ getType() [2/2]

◆ getValue() [1/5]

◆ getValue() [2/5]

◆ getValue() [3/5]

◆ getValue() [4/5]

◆ getValue() [5/5]

◆ initialisationOptionValue()

◆ operator=()

◆ setDefaultValue() [1/3]

◆ setDefaultValue() [2/3]

◆ setDefaultValue() [3/3]

◆ setType()

◆ setValue() [1/2]

◆ setValue() [2/2]

Member Data Documentation

◆ p_type

◆ p_vecDefaultValue

◆ p_vecPossibleValue

◆ p_vecValue