InputNode Class Reference

Wrapper around the underlying library for reading DOM elements (nodes). More...

#include <InputNode.h>

Inheritance diagram for InputNode:

Collaboration diagram for InputNode:

Public Member Functions
	InputNode ()
	InputNode (QDomElement domElement_h)
	~InputNode ()
bool	setWorkingFile (std::string filename_h)
	Load the file on memory. Return false if no success.
int	getIntContent ()
	Get the content between its tagName as integer.
double	getDoubleContent ()
	Get the content between its tagName as double.
string	getStringContent ()
	Get the content between its tagName as std::string.
bool	getBoolContent ()
	Get the content between its tagName as bool.
int	getIntAttributeByName (string attributeName_h)
	Get an attribute by name as integer.
double	getDoubleAttributeByName (string attributeName_h)
	Get an attribute by name as double.
string	getStringAttributeByName (string attributeName_h)
	Get an attribute by name as string.
bool	hasAttributeByName (string attributeName_h)
	Check if an attribute with a certain name exist.
InputNode	getNodeByName (string nodeName_h, int debugLevel=MSG_CRITICAL_ERROR, bool childFlag=false)
	return 0-or-1 nodes by name.
vector< InputNode >	getNodesByName (string nodeName_h, int debugLevel=MSG_WARNING, bool childFlag=false)
vector< InputNode >	getChildNodes ()
	Retrieve a child node with gived name and optionally with gived attribute or gived pair attribute/value. It raises an error if more than one.
bool	hasChildNode (string name_h)
	True if it has specified child node.
int	getChildNodesCount ()
	Only Elements
string	getNodeName ()
Public Member Functions inherited from BaseClass
	BaseClass ()
	~BaseClass ()
void	msgOut (const int &msgCode_h, const string &msg_h, const bool &refreshGUI_h=true) const
	Overloaded function to print the output log.
void	msgOut (const int &msgCode_h, const int &msg_h, const bool &refreshGUI_h=true) const
	Overloaded function to print the output log.
void	msgOut (const int &msgCode_h, const double &msg_h, const bool &refreshGUI_h=true) const
	Overloaded function to print the output log.
int	s2i (const string &string_h) const
	string to integer conversion
double	s2d (const string &string_h) const
	string to double conversion
double	s2d (const string &string_h, const bool &replaceComma) const
	string to double conversion
bool	s2b (const string &string_h) const
	string to bool conversion
string	i2s (const int &int_h) const
	integer to string conversion
string	d2s (const double &double_h) const
	double to string conversion
string	b2s (const bool &bool_h) const
	bool to string conversion
vector< int >	s2i (const vector< string > &string_h) const
	string to integer conversion (vector)
vector< double >	s2d (const vector< string > &string_h, const bool &replaceComma=false) const
	string to double conversion (vector)
vector< bool >	s2b (const vector< string > &string_h) const
	string to bool conversion (vector)
vector< string >	i2s (const vector< int > &int_h) const
	integer to string conversion (vector)
vector< string >	d2s (const vector< double > &double_h) const
	double to string conversion (vector)
vector< string >	b2s (const vector< bool > &bool_h) const
	bool to string conversion (vector)
int	getType (const string &type_h) const
	Return a type according to enum TYPE_* from a string (eg: "string" -> TYPE_STRING (2))
void	refreshGUI () const
	Ping to periodically return the control to the GUI.
template<typename T >
string	toString (const T &x) const
template<typename T >
T	stringTo (const std::string &s) const
int	vSum (const vector< int > &vector_h) const
double	vSum (const vector< double > &vector_h) const
int	vSum (const vector< vector< int > > &vector_h) const
double	vSum (const vector< vector< double > > &vector_h) const
void	tokenize (const string &str, vector< string > &tokens, const string &delimiter=" ") const
	Tokenize a string using a delimiter (default is space)
void	untokenize (string &str, vector< string > &tokens, const string &delimiter=" ") const
template<typename K , typename V >
V	findMap (const map< K, V > &mymap, const K &key, const int &error_level=MSG_CRITICAL_ERROR, const V &notFoundValue=numeric_limits< V >::min()) const
	Lookup a map for a value. Return the value starting from the key.
template<typename K , typename V >
void	changeMapValue (map< K, V > &mymap, const K &key, const V &value, const int &error_level=MSG_CRITICAL_ERROR)
	Change the value stored in a map given the key and the new value.
template<typename K , typename V >
void	incrMapValue (map< K, V > &mymap, const K &key, const V &value, const int &error_level=MSG_CRITICAL_ERROR)
	Increments a value stored in a map of the specified value, given the key.
template<typename K , typename V >
void	incrOrAddMapValue (map< K, V > &mymap, const K &key, const V &value)
	Increments a value stored in a map of the specified value, given the key.
template<typename K , typename V >
void	resetMapValues (map< K, V > &mymap, const V &value)
	Reset all values stored in a map to the specified one.
template<typename K , typename V >
map< K, V >	vectorToMap (const vector< K > &keys, const V &value=0.0)
	Returns a map built using the given vector and the given (scalar) value as keys/values pairs.
template<typename T >
vector< T >	positionsToContent (const vector< T > &vector_h, const vector< int > &positions)
	Return a vector of content from a vector and a vector of positions (int)
template<typename V >
void	debugMap (const map< iisskey, V > &mymap)
	Debug a map.
template<typename K , typename V >
void	debugMap (const map< K, V > &mymap, const K &key)
template<typename K >
int	getMaxPos (const vector< K > &v)
	Returns the position of the maximum element in the vector (the last one in case of multiple equivalent maxima)
template<typename K >
int	getMinPos (const vector< K > &v)
	Returns the position of the minimum element in the vector (the first one in case of multiple equivalent minima)
template<typename K >
K	getMax (const vector< K > &v)
	Returns the value of the maximum element in the vector (the last one in case of multiple equivalent maxima)
template<typename K >
K	getMin (const vector< K > &v)
	Returns the value of the minimum element in the vector (the first one in case of multiple equivalent minima)
template<typename K >
double	getAvg (const vector< K > &v)
	Returns the average of the elements in the vector.
template<typename K >
double	getSd (const vector< K > &v, bool sample=true)
template<typename K >
int	getPos (const K &element, const vector< K > &v, const int &msgCode_h=MSG_CRITICAL_ERROR)
template<typename K >
bool	inVector (const K &element, const vector< K > &v)
double	normSample (const double &avg, const double &stdev, const double &minval=NULL, const double &maxval=NULL) const
	Sample from a normal distribution with bounds. Slower (double time, but still you see the diff only after milion of loops).
template<typename K >
K	normSample (normal_distribution< K > &d, std::mt19937 &gen, const K &minval=NULL, const K &maxval=NULL) const
	Sample from a normal distribution with bounds. Faster (half time) as the normal_distribution is made only once.
template<typename T >
std::string	toString (const T &x) const

Private Attributes
QDomElement	domElement
	The underlying library-depending DOM rappresentation of the element.

Additional Inherited Members
Protected Attributes inherited from BaseClass
ThreadManager *	MTHREAD
	Pointer to the Thread manager.

Detailed Description

Wrapper around the underlying library for reading DOM elements (nodes).

A small wrapper class using an underlying library (currently QtXml) to read DOM nodes.
This class works with the individual nodes (DOM Elements), while the companion class InputDocument wrapper the whole document (DOM Document).
Note: In the DOM terminology "Elements" are a subset of the more general "nodes" (that include comments and other typologies..)

Author

Antonello Lobianco

Definition at line 51 of file InputNode.h.

Constructor & Destructor Documentation

InputNode() [1/2]

InputNode

(

)

Definition at line 30 of file InputNode.cpp.

                    {
}

InputNode() [2/2]

InputNode ( QDomElement  domElement_h )

inline

Definition at line 55 of file InputNode.h.

{domElement=domElement_h;}; //<Constructor

~InputNode()

~InputNode

(

)

Definition at line 33 of file InputNode.cpp.

                     {
}

Member Function Documentation

getBoolContent()

bool getBoolContent

(

)

Get the content between its tagName as bool.

Definition at line 79 of file InputNode.cpp.

                         {
  string content = domElement.text().toStdString();
  if (content == "false" || content == "falso" || content == "FALSE" || content == "0")
    return false;
  else if (content == "true" || content == "vero" || content == "TRUE" || content == "1")
    return true;
  msgOut(MSG_WARNING, "Sorry, I don't know how to convert "+content+" to a bool value. I return true... hope for the best");
  return true;
}

Here is the call graph for this function:

getChildNodes()

vector< InputNode > getChildNodes

(

)

Retrieve a child node with gived name and optionally with gived attribute or gived pair attribute/value. It raises an error if more than one.

Retrieve all child nodes with gived name and optionally with gived attribute or gived pair attribute/value. It raises an error if more than one. Filtered to return only child Elements

Definition at line 235 of file InputNode.cpp.

                        {
  vector <InputNode> myNodeVector;
  QDomNodeList myElementList = domElement.childNodes();
  for (int i=0;i<myElementList.size();i++){
    if (myElementList.item(i).nodeType() == QDomNode::ElementNode ){
      InputNode myInputNode(myElementList.item(i).toElement());
      myNodeVector.push_back(myInputNode);
    }
  }
  return myNodeVector;
}

getChildNodesCount()

int getChildNodesCount

(

)

Only Elements

Definition at line 260 of file InputNode.cpp.

                             {
  int myElementListCountInt = 0;
  QDomNodeList myElementList = domElement.childNodes();
  for (int i=0;i<myElementList.size();i++){
    if (myElementList.item(i).nodeType() == QDomNode::ElementNode ){
      myElementListCountInt++ ;
    }
  }
  return myElementListCountInt;
}

getDoubleAttributeByName()

double getDoubleAttributeByName

(

std::string

attributeName_h

)

Get an attribute by name as double.

Definition at line 100 of file InputNode.cpp.

                                                            {
  if (domElement.hasAttribute(attributeName_h.c_str())){
    return domElement.attribute(attributeName_h.c_str()).toDouble();
  }else{
    msgOut(MSG_ERROR, "Element doens't have attribute " + attributeName_h );
    return 0;
  }
}

Here is the call graph for this function:

getDoubleContent()

double getDoubleContent

(

)

Get the content between its tagName as double.

Definition at line 69 of file InputNode.cpp.

                           {
  return domElement.text().toDouble(); // This is a Qt function that works both with dot and comma separators !
}

getIntAttributeByName()

int getIntAttributeByName

(

std::string

attributeName_h

)

Get an attribute by name as integer.

Definition at line 90 of file InputNode.cpp.

                                                         {
  if (domElement.hasAttribute(attributeName_h.c_str())){
    return domElement.attribute(attributeName_h.c_str()).toInt();
  }else{
    msgOut(MSG_ERROR, "Element doens't have attribute " + attributeName_h );
    return 0;
  }
}

Here is the call graph for this function:

getIntContent()

int getIntContent

(

)

Get the content between its tagName as integer.

Definition at line 64 of file InputNode.cpp.

                        {
  return domElement.text().toInt();
}

getNodeByName()

InputNode getNodeByName	(	string	nodeName_h,
		int	debugLevel = MSG_CRITICAL_ERROR,
		bool	childFlag = false
	)

return 0-or-1 nodes by name.

Definition at line 129 of file InputNode.cpp.

                                                                         {
  /*
  QDomNodeList myElementList = domElement.elementsByTagName ( nodeName_h.c_str() );
  if (myElementList.size()>1){
    msgOut(debugLevel, "Too many elements. Expected only one of type "+nodeName_h);
  }
  if (myElementList.isEmpty()){
    msgOut(debugLevel, "No elements in the XML file. Expected 1 of type "+nodeName_h);
  }
  QDomElement myElement = myElementList.item(0).toElement() ;
  InputNode myInputNode(myElement);
  return myInputNode; */
  vector<InputNode> myNodes = getNodesByName(nodeName_h, debugLevel, childFlag);
  if (myNodes.size()>1){
    msgOut(debugLevel, "Too many elements. Expected only one of type "+nodeName_h);
    return myNodes[0];
  }
  if (myNodes.size() == 0){
    msgOut(debugLevel, "No elements in the XML file. Expected 1 of type "+nodeName_h+". Returning emty node!!");
    InputNode toReturn;
    return toReturn;
  }
  return myNodes[0];
}

Here is the call graph for this function:

getNodeName()

string getNodeName

(

)

Definition at line 272 of file InputNode.cpp.

                      {
  return domElement.tagName().toStdString();
}

getNodesByName()

vector< InputNode > getNodesByName	(	string	nodeName_h,
		int	debugLevel = MSG_WARNING,
		bool	childFlag = false
	)

return 0-to-n nodes by name

Definition at line 155 of file InputNode.cpp.

                                                                          {
  vector <InputNode> myNodeVector;
  if (!childFlag){
    QDomNodeList myElementList = domElement.elementsByTagName ( nodeName_h.c_str() );
    for (int i=0;i<myElementList.size();i++){
      InputNode myInputNode(myElementList.item(i).toElement());
      myNodeVector.push_back(myInputNode);
    }
    
  }
  else {
    QDomNodeList myElementList = domElement.childNodes();
    for (int i=0;i<myElementList.size();i++){
      if (   myElementList.item(i).nodeType() == QDomNode::ElementNode
          && myElementList.item(i).toElement().tagName().toStdString() == nodeName_h){
        InputNode myInputNode(myElementList.item(i).toElement());
        myNodeVector.push_back(myInputNode);
      }
    }
  }
  if (myNodeVector.size()==0){
    msgOut(debugLevel, "No elements in the XML file. Expected at least one of type "+nodeName_h);
  }
  //for (int i=0;i<myElementList.size();i++){
  //  InputNode myInputNode(myElementList.item(i).toElement());
  //  myNodeVector.push_back(myInputNode);
 
    /*InputNode myInputNode(myElementList.item(i).toElement());
    string firstNodeContent= myInputNode.getStringContent();
    // checking that the setting is not an empy line nor a comment (e.g. starting with "#")..
    if(firstNodeContent=="") continue;
    unsigned int z;
    z = firstNodeContent.find("#");
    if( z!=string::npos && z == 0) continue;
    // chacking also the "childs" as in the XMLs deriving from csv I want delete the whole "<record>" tree, including his childs (fields)
    vector <InputNode> childs = myInputNode.getChildNodes();
    if(childs.size()>0){
      string firstChildContent= childs[0].getStringContent();
      // checking that the setting is not an empy line nor a comment (e.g. starting with "#")..
      if(firstChildContent=="") continue;
      unsigned int y;
      y = firstChildContent.find("#");
      if( y!=string::npos && y == 0) continue;
    }
    myNodeVector.push_back(myInputNode);
    */
 
 
  //}
  return myNodeVector;
}

Referenced by getNodeByName(), Gis::initLayers(), and ModelData::loadInput().

Here is the call graph for this function:

Here is the caller graph for this function:

getStringAttributeByName()

string getStringAttributeByName

(

std::string

attributeName_h

)

Get an attribute by name as string.

Definition at line 110 of file InputNode.cpp.

                                                            {
  if (domElement.hasAttribute(attributeName_h.c_str())){
    return domElement.attribute(attributeName_h.c_str()).toStdString();
  }else{
    msgOut(MSG_ERROR, "Element doens't have attribute " + attributeName_h );
    return "";
  }
}

Here is the call graph for this function:

getStringContent()

std::string getStringContent

(

)

Get the content between its tagName as std::string.

Definition at line 74 of file InputNode.cpp.

                           {
  return domElement.text().toStdString();
}

hasAttributeByName()

bool hasAttributeByName

(

std::string

attributeName_h

)

Check if an attribute with a certain name exist.

Definition at line 120 of file InputNode.cpp.

                                                      {
  if (domElement.hasAttribute(attributeName_h.c_str())){
    return 1;
  }else{
    return 0;
  }
}

hasChildNode()

bool hasChildNode

(

string

name_h

)

True if it has specified child node.

Definition at line 248 of file InputNode.cpp.

                                    {
  bool toReturn = false;
  QDomNodeList myElementList = domElement.childNodes();
  for (int i=0;i<myElementList.size();i++){
    if (myElementList.item(i).nodeType() == QDomNode::ElementNode ){
      if(myElementList.item(i).toElement().tagName().toStdString() == name_h) return true;
    }
  }
  return toReturn;
}

setWorkingFile()

bool setWorkingFile

(

std::string

filename_h

)

Load the file on memory. Return false if no success.

Definition at line 37 of file InputNode.cpp.

                                             {
 
  QString errorStr;
  int errorLine;
  int errorColumn;
  
  QFile file(filename_h.c_str());
  QIODevice* device;
  device = &file;
    
  QDomDocument doc;
  if (!doc.setContent(device, true, &errorStr, &errorLine, &errorColumn)) {
    string message = "XML error on file "+ filename_h + " at line ";
    message.append(i2s(errorLine));
    message.append(" column ");
    message = message.c_str() + i2s(errorColumn);
    message = message + ": ";
    message = message + errorStr.toStdString();
    msgOut(MSG_WARNING, message.c_str());
    return false;
    }
  domElement = doc.documentElement();
  return true;
}

Referenced by Gis::initLayers(), and ModelData::loadInput().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

domElement

QDomElement domElement

private

The underlying library-depending DOM rappresentation of the element.

Definition at line 80 of file InputNode.h.

Referenced by getBoolContent(), getChildNodes(), getChildNodesCount(), getDoubleAttributeByName(), getDoubleContent(), getIntAttributeByName(), getIntContent(), getNodeName(), getNodesByName(), getStringAttributeByName(), getStringContent(), hasAttributeByName(), hasChildNode(), InputNode(), and setWorkingFile().

---

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

• /exports/ffsm/src_latest/src/InputNode.h
• /exports/ffsm/src_latest/src/InputNode.cpp