phoenix_get_string.cpp File Reference

#include "phoenix_get_string.h"

Include dependency graph for phoenix_get_string.cpp:

Go to the source code of this file.

Functions
bool	phoenix_convertBoolType (const PString &strConfig)
	Convert the configuration of the cleaning type into a bool. More...
PString	phoenix_get_string (const DicoValue &dico, const PString &varName, const PString &defaultValue)
	Get the string from a dictionnary. More...
PString	phoenix_get_string (const DicoValue &dico, const PString &varName, const PString &defaultValue, const PString &defaultValue2)
	Get the string from a dictionnary. More...
PVecString	phoenix_get_vecstring (const DicoValue &dico, const PString &varName)
	Load a vector of string from a dictionnary. More...
void	phoenix_get_vecstring (PVecString &vecValue, const DicoValue &dico, const PString &varName)
	Load a vector of string from a dictionnary. More...
template<>
bool	phoenix_load_value_from_config< bool > (const DicoValue &dico, const PString &varName, bool defaultValue)
	Get bool value from a dictionnary (specialization for bool) More...
template<>
bool	phoenix_load_value_from_dico< bool > (bool &value, const DicoValue &dico, const PString &varName)
	Get bool value from a dictionnary (specialization for bool) More...
template<>
bool	phoenix_save_value_to_dico< bool > (DicoValue &dico, const bool &value, const PString &varName)
	Save the value to a dictionnary (specialization for bool) More...

Function Documentation

phoenix_convertBoolType()

bool phoenix_convertBoolType

(

const PString &

strConfig

)

Convert the configuration of the cleaning type into a bool.

Parameters

strConfig

: configuration string

Returns

corresponding value

Definition at line 13 of file phoenix_get_string.cpp.

                                                       {
        PString config(strConfig.toLower());
        return config == "true" || strConfig == "1" || config == "yes";
}

References PString::toLower().

Referenced by convertBoolType(), phoenix_load_value_from_config< bool >(), and phoenix_load_value_from_dico< bool >().

Here is the call graph for this function:

Here is the caller graph for this function:

phoenix_get_string() [1/2]

PString phoenix_get_string	(	const DicoValue &	dico,
		const PString &	varName,
		const PString &	defaultValue
	)

Get the string from a dictionnary.

Parameters

dico	: dictionnary to be used
varName	: name of the variable to be used
defaultValue	: default value

Returns

loaded string or default value

Definition at line 101 of file phoenix_get_string.cpp.

                                                                                                         {
        const DicoValue * param = dico.getMap(varName);
        if(param == NULL){
                return defaultValue;
        }else{
                return param->getString();
        }
}

References DicoValue::getMap(), and DicoValue::getString().

Referenced by checkLoadFromConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

phoenix_get_string() [2/2]

PString phoenix_get_string	(	const DicoValue &	dico,
		const PString &	varName,
		const PString &	defaultValue,
		const PString &	defaultValue2
	)

Get the string from a dictionnary.

Parameters

dico	: dictionnary to be used
varName	: name of the variable to be used
defaultValue	: default value
defaultValue2	: default value to be used if the first defaultValue is empty

Returns

loaded string or default value

Definition at line 117 of file phoenix_get_string.cpp.

                                                                                                                                        {
        const DicoValue * param = dico.getMap(varName);
        if(param == NULL){
                if(defaultValue != ""){
                        return defaultValue;
                }else{
                        return defaultValue2;
                }
        }else{
                return param->getString();
        }
}

References DicoValue::getMap(), and DicoValue::getString().

Here is the call graph for this function:

phoenix_get_vecstring() [1/2]

PVecString phoenix_get_vecstring	(	const DicoValue &	dico,
		const PString &	varName
	)

Load a vector of string from a dictionnary.

Parameters

dico	: dictionnary to be used
varName	: name of the variable to be used

Returns

loaded vector of values

Definition at line 88 of file phoenix_get_string.cpp.

                                                                                 {
        PVecString out;
        phoenix_get_vecstring(out, dico, varName);
        return out;
}

References phoenix_get_vecstring().

Here is the call graph for this function:

phoenix_get_vecstring() [2/2]

void phoenix_get_vecstring	(	PVecString &	vecValue,
		const DicoValue &	dico,
		const PString &	varName
	)

Load a vector of string from a dictionnary.

Parameters

[out]	vecValue	: loaded vector of values
	dico	: dictionnary to be used
	varName	: name of the variable to be used

Definition at line 72 of file phoenix_get_string.cpp.

                                                                                                  {
        const DicoValue * param = dico.getMap(varName);
        if(param == NULL){
                return;
        }
        const VecDicoValue & vecChildValue = param->getVecChild();
        for(VecDicoValue::const_iterator it(vecChildValue.begin()); it != vecChildValue.end(); ++it){
                vecValue.push_back(it->getString());
        }
}

References DicoValue::getMap(), and DicoValue::getVecChild().

Referenced by checkLoadFromConfig(), and phoenix_get_vecstring().

Here is the call graph for this function:

Here is the caller graph for this function:

phoenix_load_value_from_config< bool >()

template<>

bool phoenix_load_value_from_config< bool >	(	const DicoValue &	dico,
		const PString &	varName,
		bool	defaultValue
	)

Get bool value from a dictionnary (specialization for bool)

Parameters

dico	: dictionnary to be used
varName	: name of the variable to be used
defaultValue	: default value

Returns

loaded value or default value

Definition at line 25 of file phoenix_get_string.cpp.

                                                                                                             {
        const DicoValue * param = dico.getMap(varName);
        if(param == NULL){
                return defaultValue;
        }else{
                return phoenix_convertBoolType(param->getString());
        }
}

References DicoValue::getMap(), DicoValue::getString(), and phoenix_convertBoolType().

Referenced by checkLoadFromConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

phoenix_load_value_from_dico< bool >()

template<>

bool phoenix_load_value_from_dico< bool >	(	bool &	value,
		const DicoValue &	dico,
		const PString &	varName
	)

Get bool value from a dictionnary (specialization for bool)

Parameters

[out]	value	: value to be loaded
	dico	: dictionnary to be used
	varName	: name of the variable to be used
	defaultValue	: default value

Returns

loaded value or default value

Definition at line 42 of file phoenix_get_string.cpp.

                                                                                                      {
        const DicoValue * param = dico.getMap(varName);
        if(param == NULL){
                return false;
        }else{
                value = phoenix_convertBoolType(param->getString());
                return true;
        }
}

References DicoValue::getMap(), DicoValue::getString(), and phoenix_convertBoolType().

Referenced by checkLoadFromConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

phoenix_save_value_to_dico< bool >()

template<>

bool phoenix_save_value_to_dico< bool >	(	DicoValue &	dico,
		const bool &	value,
		const PString &	varName
	)

Save the value to a dictionnary (specialization for bool)

Parameters

[out]	dico	: dictionnary to be updated
	value	: value to be saved
	varName	: name of the variable to be used

Returns

true if the value was saved, false otherwise (return is always true)

Definition at line 59 of file phoenix_get_string.cpp.

                                                                                                    {
        std::string strValue("false");
        if(value){
                strValue = "true";
        }
        return phoenix_save_value_to_dico(dico, strValue, varName);
}

References phoenix_save_value_to_dico().

Referenced by checkLoadFromConfig().

Here is the call graph for this function:

Here is the caller graph for this function: