PhoenixFileParser  1.0.0
Set of tools to ease file parsing
Loading...
Searching...
No Matches
Functions
phoenix_get_string.h File Reference
#include "DicoValue.h"
#include "phoenix_get_string_impl.h"
+ Include dependency graph for phoenix_get_string.h:
+ This graph shows which files directly or indirectly include this file:

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.
 
PString phoenix_get_nested_string (const DicoValue &dico, const PVecString &vecVarAddress)
 Get a nested value in the DicoValue.
 
PString phoenix_get_string (const DicoValue &dico, const PString &varName, const PString &defaultValue)
 Get the string from a dictionnary.
 
PString phoenix_get_string (const DicoValue &dico, const PString &varName, const PString &defaultValue, const PString &defaultValue2)
 Get the string from a dictionnary.
 
PVecString phoenix_get_vecstring (const DicoValue &dico, const PString &varName)
 Load a vector of string from a dictionnary.
 
void phoenix_get_vecstring (PVecString &vecValue, const DicoValue &dico, const PString &varName)
 Load a vector of string from a dictionnary.
 
template<typename T>
T phoenix_load_value_from_config (const DicoValue &dico, const PString &varName, T defaultValue)
 Get the value from a dictionnary.
 
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)
 
template<typename T>
bool phoenix_load_value_from_dico (T &value, const DicoValue &dico, const PString &varName)
 Get the value from a dictionnary.
 
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)
 
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.
 
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.
 
template<typename T>
bool phoenix_save_value_to_dico (DicoValue &dico, const T &value, const PString &varName)
 Save the value to a dictionnary.
 
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)
 

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.

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

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

+ Here is the caller graph for this function:

◆ phoenix_get_nested_string()

PString phoenix_get_nested_string ( const DicoValue & dico,
const PVecString & vecVarAddress )

Get a nested value in the DicoValue.

Parameters
dico: dictionnary to be used
vecVarAddress: vector of names to get the value
Returns
loaded string or default value

Definition at line 135 of file phoenix_get_string.cpp.

135 {
136 if(vecVarAddress.size() == 0lu){return "";}
137 const DicoValue * tmpDico = dico.getMap(vecVarAddress);
138 PString outputValue;
139 if(tmpDico != NULL){ //We get all keys until the end of the vector
140 outputValue = tmpDico->getString();
141 }
142 return outputValue;
143}
DicoValue
Dictionnary of values.
Definition DicoValue.h:17
DicoValue::getMap
const DicoValue * getMap(const PString &key) const
Get a DicoValue in the map of the current one.
Definition DicoValue.cpp:117
DicoValue::getString
PString getString() const
Get a string value without the first and/or last quote or double quote in there are some.
Definition DicoValue.cpp:229

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

+ Here is the call 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.

101 {
102 const DicoValue * param = dico.getMap(varName);
103 if(param == NULL){
104 return defaultValue;
105 }else{
106 return param->getString();
107 }
108}

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

+ Here is the call 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.

117 {
118 const DicoValue * param = dico.getMap(varName);
119 if(param == NULL){
120 if(defaultValue != ""){
121 return defaultValue;
122 }else{
123 return defaultValue2;
124 }
125 }else{
126 return param->getString();
127 }
128}

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.

88 {
89 PVecString out;
90 phoenix_get_vecstring(out, dico, varName);
91 return out;
92}
phoenix_get_vecstring
void phoenix_get_vecstring(PVecString &vecValue, const DicoValue &dico, const PString &varName)
Load a vector of string from a dictionnary.
Definition phoenix_get_string.cpp:72

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.

72 {
73 const DicoValue * param = dico.getMap(varName);
74 if(param == NULL){
75 return;
76 }
77 const VecDicoValue & vecChildValue = param->getVecChild();
78 for(VecDicoValue::const_iterator it(vecChildValue.begin()); it != vecChildValue.end(); ++it){
79 vecValue.push_back(it->getString());
80 }
81}
VecDicoValue
std::vector< DicoValue > VecDicoValue
Vector of DicoValue.
Definition DicoValue.h:80
DicoValue::getVecChild
const std::vector< DicoValue > & getVecChild() const
Gets the vecChild of the DicoValue.
Definition DicoValue.cpp:250

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

Referenced by phoenix_get_vecstring().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ 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.

20 {
21 const DicoValue * param = dico.getMap(varName);
22 if(param == NULL){
23 return defaultValue;
24 }else{
25 return param->getValue<T>();
26 }
27}
DicoValue::getValue
T getValue() const
Convert the value of the current DicoValue into a type.
Definition DicoValue_impl.h:16

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

+ Here is the call 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.

25 {
26 const DicoValue * param = dico.getMap(varName);
27 if(param == NULL){
28 return defaultValue;
29 }else{
30 return phoenix_convertBoolType(param->getString());
31 }
32}
phoenix_convertBoolType
bool phoenix_convertBoolType(const PString &strConfig)
Convert the configuration of the cleaning type into a bool.
Definition phoenix_get_string.cpp:13

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

+ 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.

36 {
37 const DicoValue * param = dico.getMap(varName);
38 if(param == NULL){
39 return false;
40 }else{
41 value = param->getValue<T>();
42 return true;
43 }
44}

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

+ Here is the call 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.

42 {
43 const DicoValue * param = dico.getMap(varName);
44 if(param == NULL){
45 return false;
46 }else{
47 value = phoenix_convertBoolType(param->getString());
48 return true;
49 }
50}

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

+ Here is the call 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.

84 {
85 std::vector<T> out;
86 phoenix_load_vecValue_from_config(out, dico, varName);
87 return out;
88}
phoenix_load_vecValue_from_config
void phoenix_load_vecValue_from_config(std::vector< T > &vecValue, const DicoValue &dico, const PString &varName)
Load a vector of value from a dictionnary.
Definition phoenix_get_string_impl.h:67

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.

67 {
68 const DicoValue * param = dico.getMap(varName);
69 if(param == NULL){
70 return;
71 }
72 const VecDicoValue & vecChildValue = param->getVecChild();
73 for(VecDicoValue::const_iterator it(vecChildValue.begin()); it != vecChildValue.end(); ++it){
74 vecValue.push_back(it->getValue<T>());
75 }
76}

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.

53 {
54 DicoValue param;
55 param.setKey(varName);
56 param.setValue(valueToString(value));
57 dico.getMapChild()[varName] = param;
58 return true;
59}
DicoValue::setKey
void setKey(const PString &key)
Sets the key of the DicoValue.
Definition DicoValue.cpp:194
DicoValue::setValue
void setValue(const PString &value)
Sets the value of the DicoValue.
Definition DicoValue.cpp:187
DicoValue::getMapChild
const std::map< PString, DicoValue > & getMapChild() const
Gets the mapChild of the DicoValue.
Definition DicoValue.cpp:264

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

Referenced by phoenix_save_value_to_dico< bool >().

+ 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.

59 {
60 std::string strValue("false");
61 if(value){
62 strValue = "true";
63 }
64 return phoenix_save_value_to_dico(dico, strValue, varName);
65}
phoenix_save_value_to_dico
bool phoenix_save_value_to_dico(DicoValue &dico, const T &value, const PString &varName)
Save the value to a dictionnary.
Definition phoenix_get_string_impl.h:53

References phoenix_save_value_to_dico().

+ Here is the call graph for this function: