phoenix_get_string_impl.h File Reference

#include "convertToString.h"
#include "phoenix_get_string.h"

Include dependency graph for phoenix_get_string_impl.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
template<typename T >
T	phoenix_load_value_from_config (const DicoValue &dico, const PString &varName, T defaultValue)
	Get the value from a dictionnary. More...
template<typename T >
bool	phoenix_load_value_from_dico (T &value, const DicoValue &dico, const PString &varName)
	Get the value from a dictionnary. More...
template<typename T >
std::vector< T >	phoenix_load_vecValue_from_config (const DicoValue &dico, const PString &varName)
	Load a vector of value from a dictionnary. More...
template<typename T >
void	phoenix_load_vecValue_from_config (std::vector< T > &vecValue, const DicoValue &dico, const PString &varName)
	Load a vector of value from a dictionnary. More...
template<typename T >
bool	phoenix_save_value_to_dico (DicoValue &dico, const T &value, const PString &varName)
	Save the value to a dictionnary. More...

Function Documentation

phoenix_load_value_from_config()

template<typename T >

T phoenix_load_value_from_config	(	const DicoValue &	dico,
		const PString &	varName,
		T	defaultValue
	)

Get the value from a dictionnary.

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 20 of file phoenix_get_string_impl.h.

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

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

Here is the call graph for this function:

phoenix_load_value_from_dico()

template<typename T >

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

Get the value from a dictionnary.

Parameters

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

Returns

true if the value was loaded, false otherwise

Definition at line 36 of file phoenix_get_string_impl.h.

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

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

Referenced by checkLoadFromConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

phoenix_load_vecValue_from_config() [1/2]

template<typename T >

std::vector<T> phoenix_load_vecValue_from_config	(	const DicoValue &	dico,
		const PString &	varName
	)

Load a vector of value 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 84 of file phoenix_get_string_impl.h.

                                                                                               {
        std::vector<T> out;
        phoenix_load_vecValue_from_config(out, dico, varName);
        return out;
}

References phoenix_load_vecValue_from_config().

Here is the call graph for this function:

phoenix_load_vecValue_from_config() [2/2]

template<typename T >

void phoenix_load_vecValue_from_config	(	std::vector< T > &	vecValue,
		const DicoValue &	dico,
		const PString &	varName
	)

Load a vector of value 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 67 of file phoenix_get_string_impl.h.

                                                                                                                {
        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->getValue<T>());
        }
}

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

Referenced by phoenix_load_vecValue_from_config().

Here is the call graph for this function:

Here is the caller graph for this function:

phoenix_save_value_to_dico()

template<typename T >

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

Save the value to a dictionnary.

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 53 of file phoenix_get_string_impl.h.

                                                                                           {
        DicoValue param;
        param.setKey(varName);
        param.setValue(valueToString(value));
        dico.getMapChild()[varName] = param;
        return true;
}

References DicoValue::getMapChild(), DicoValue::setKey(), DicoValue::setValue(), and valueToString().

Referenced by phoenix_save_value_to_dico< bool >().

Here is the call graph for this function:

Here is the caller graph for this function: