PhoenixFileParser  1.5.1
Set of tools to ease file parsing
Loading...
Searching...
No Matches
Functions
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.
 
PString phoenix_get_nested_string (const DicoValue &dico, const PVecString &vecVarAddress)
 Get a nested value in the DicoValue.
 
PString phoenix_get_string (const ConfigNode &dico, const PString &varName, const PString &defaultValue)
 Get the string from a ConfigNode.
 
PString phoenix_get_string (const ConfigNode &dico, const PString &varName, const PString &defaultValue, const PString &defaultValue2)
 Get the string from a ConfigNode.
 
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.
 
template<>
bool phoenix_get_value (const ConfigNode &dico, const PString &varName, const bool &defaultValue)
 Get the string from a ConfigNode (specialisation for bool)
 
PVecString phoenix_get_vecstring (const ConfigNode &dico, const PString &varName)
 Load a vector of string from a ConfigNode.
 
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 ConfigNode &dico, const PString &varName)
 Load a vector of string from a ConfigNode.
 
void phoenix_get_vecstring (PVecString &vecValue, const DicoValue &dico, const PString &varName)
 Load a vector of string 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<>
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<>
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_get_value(), 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/4]

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

Get the string from a ConfigNode.

Parameters
dico: ConfigNode to be used
varName: name of the variable to be used
defaultValue: default value
Returns
loaded string or default value

Definition at line 167 of file phoenix_get_string.cpp.

167 {
168 const ConfigNode * param = dico.getChild(varName);
169 if(param == NULL){
170 return defaultValue;
171 }else{
172 return param->getString();
173 }
174}
ConfigNode
Configuration of values.
Definition ConfigNode.h:18
ConfigNode::getString
PString getString() const
Get string value without " or ' at the beginning of the end.
Definition ConfigNode.cpp:229
ConfigNode::getChild
ConfigNode * getChild(const PString &name)
Get the child of the given name.
Definition ConfigNode.cpp:194

References ConfigNode::getChild(), and ConfigNode::getString().

+ Here is the call graph for this function:

◆ phoenix_get_string() [2/4]

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

Get the string from a ConfigNode.

Parameters
dico: ConfigNode 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 183 of file phoenix_get_string.cpp.

183 {
184 const ConfigNode * param = dico.getChild(varName);
185 if(param == NULL){
186 if(defaultValue != ""){
187 return defaultValue;
188 }else{
189 return defaultValue2;
190 }
191 }else{
192 return param->getString();
193 }
194}

References ConfigNode::getChild(), and ConfigNode::getString().

+ Here is the call graph for this function:

◆ phoenix_get_string() [3/4]

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() [4/4]

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_value()

template<>
bool phoenix_get_value ( const ConfigNode & dico,
const PString & varName,
const bool & defaultValue )

Get the string from a ConfigNode (specialisation for bool)

Parameters
dico: ConfigNode to be used
varName: name of the variable to be used
defaultValue: default value
Returns
loaded string or default value

Definition at line 152 of file phoenix_get_string.cpp.

152 {
153 const ConfigNode * param = dico.getChild(varName);
154 if(param == NULL){
155 return defaultValue;
156 }else{
157 return phoenix_convertBoolType(param->getString());
158 }
159}
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 ConfigNode::getChild(), ConfigNode::getString(), and phoenix_convertBoolType().

+ Here is the call graph for this function:

◆ phoenix_get_vecstring() [1/4]

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

Load a vector of string from a ConfigNode.

Parameters
dico: ConfigNode to be used
varName: name of the variable to be used
Returns
loaded vector of values

Definition at line 217 of file phoenix_get_string.cpp.

217 {
218 PVecString out;
219 phoenix_get_vecstring(out, dico, varName);
220 return out;
221}
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/4]

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}

References phoenix_get_vecstring().

+ Here is the call graph for this function:

◆ phoenix_get_vecstring() [3/4]

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

Load a vector of string from a ConfigNode.

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

Definition at line 201 of file phoenix_get_string.cpp.

201 {
202 const ConfigNode * param = dico.getChild(varName);
203 if(param == NULL){
204 return;
205 }
206 const VecConfigNode & vecChildValue = param->getVecChild();
207 for(VecConfigNode::const_iterator it(vecChildValue.begin()); it != vecChildValue.end(); ++it){
208 vecValue.push_back((*it)->getString());
209 }
210}
VecConfigNode
std::vector< ConfigNode * > VecConfigNode
Definition ConfigNode.h:74
ConfigNode::getVecChild
const std::vector< ConfigNode * > & getVecChild() const
Gets the vecChild of the ConfigNode.
Definition ConfigNode.cpp:93

References ConfigNode::getChild(), and ConfigNode::getVecChild().

+ Here is the call graph for this function:

◆ phoenix_get_vecstring() [4/4]

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(), 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.

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}

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

+ 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_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: