XMLIOSERVER 0.4
Serveur d'Entrées/Sorties parallèles
Référence de la classe xmlioserver::xml::CXMLNode

Classe de gestion des noeuds dans les documents XML. Plus de détails...

#include <xml_node.hpp>

Graphe de collaboration de xmlioserver::xml::CXMLNode:

Liste de tous les membres

Fonctions membres publiques

 CXMLNode (rapidxml::xml_node< char > *const _root)
 Constructeur d'un noeud xml.
 ~CXMLNode (void)
 Destructeur de l'objet.
std::string getElementName (void) const
 Retourne le nom de l'élément courant (pointé dans le document xml).
std::map< std::string,
std::string > 
getAttributes (void) const
 Retourne les valeurs d'attributs de l'élément courant (pointé dans le document xml).
bool goToNextElement (void)
 Déplace le pointeur du noeud actuel vers le suivant si possible.
bool goToChildElement (void)
 Déplace le pointeur du noeud actuel vers son premier enfant si possible.
bool goToParentElement (void)
 Déplace le pointeur du noeud actuel vers son parent si possible.

Fonctions membres publiques statiques

static const std::string & GetRootName (void)
 Retourne le nom de l'élément racine du document xml.

Fonctions membres protégées

 CXMLNode (void)
 Constructeur simple.
 CXMLNode (const CXMLNode &_node)
 Constructeur par copie .
 CXMLNode (const CXMLNode *const _node_ptr)
 Constructeur par copie.

Attributs privés

rapidxml::xml_node< char > * node
 Pointeur sur un objet de type noeud dans la bibliothèque rapidxml.

Attributs privés statiques

static std::string RootName
 Nom de l'élément racine du document xml.

Description détaillée

Classe de gestion des noeuds dans les documents XML.

Définition à la ligne 41 du fichier xml_node.hpp.


Documentation des constructeurs et destructeur

xmlioserver::xml::CXMLNode::CXMLNode ( rapidxml::xml_node< char > *const  _root)

Constructeur d'un noeud xml.

Paramètres:
_root: un noeud xml dans la bibliothèque rapidxml
Voir également:
node

Exemple d'utilisation:

 //> Création d'un noeud xml à partir de rapidxml.
 char * c_str =  "<? xml version=1.0 ?><simulation></simulation>";
 rapidxml::xml_document<char> xmldoc;
 xmldoc.parse<0>(c_str);
 CXMLNode node(doc.first_node());

Définition à la ligne 29 du fichier xml_node.cpp.

xmlioserver::xml::CXMLNode::~CXMLNode ( void  )

Destructeur de l'objet.

Définition à la ligne 36 du fichier xml_node.cpp.

xmlioserver::xml::CXMLNode::CXMLNode ( void  ) [protected]

Constructeur simple.

xmlioserver::xml::CXMLNode::CXMLNode ( const CXMLNode _node) [protected]

Constructeur par copie .

Paramètres:
_node: référence du noeud à copier.
xmlioserver::xml::CXMLNode::CXMLNode ( const CXMLNode *const  _node_ptr) [protected]

Constructeur par copie.

Paramètres:
_node_ptr: le pointeur du noeud à copier.

Documentation des fonctions membres

std::map< std::string, std::string > xmlioserver::xml::CXMLNode::getAttributes ( void  ) const

Retourne les valeurs d'attributs de l'élément courant (pointé dans le document xml).

Renvoie:
une map d'attributs identifiés par des clés dans le conteneur.

Appliquée au document xml ci_dessous, la méthode retourne pour le noeud racine la map :

  • attrib_cle1 -> attrib_value1
  • attrib_cle2 -> attrib_value2
 <? xml version=1.0 ?>
 <element_name attrib_cle1 = "attrib_value1" attrib_cle2 = "attrib_value2">
 Ceci est un contenu.
 </element_name>

Définition à la ligne 42 du fichier xml_node.cpp.

Références node.

std::string xmlioserver::xml::CXMLNode::getElementName ( void  ) const

Retourne le nom de l'élément courant (pointé dans le document xml).

Renvoie:
l'identifiant de l'élément.

Appliquée au document xml ci_dessous, la méthode retourne pour le noeud racine la chaîne element_name

 <? xml version=1.0 ?>
 <element_name attrib_cle1 = "attrib_value1" attrib_cle2 = "attrib_value2">
 Ceci est un contenu.
 </element_name>

Définition à la ligne 61 du fichier xml_node.cpp.

Références node.

Référencé par goToParentElement().

Voici le graphe d'appel pour cette fonction :

const std::string & xmlioserver::xml::CXMLNode::GetRootName ( void  ) [static]

Retourne le nom de l'élément racine du document xml.

Renvoie:
le nom de l'élément racine du document xml
Voir également:
RootName

Définition à la ligne 118 du fichier xml_node.cpp.

bool xmlioserver::xml::CXMLNode::goToChildElement ( void  )

Déplace le pointeur du noeud actuel vers son premier enfant si possible.

Renvoie:
true si le noeud pointe désormais sur l'élément enfant, false s'il n'y a pas d'élément enfant.
Voir également:
goToNextElement goToParentElement

Définition à la ligne 86 du fichier xml_node.cpp.

Références node.

bool xmlioserver::xml::CXMLNode::goToNextElement ( void  )

Déplace le pointeur du noeud actuel vers le suivant si possible.

Renvoie:
true si le noeud pointe désormais sur l'élément suivant, false s'il n'y a pas d'élément suivant.
Voir également:
goToChildElement goToParentElement

Définition à la ligne 69 du fichier xml_node.cpp.

Références node.

bool xmlioserver::xml::CXMLNode::goToParentElement ( void  )

Déplace le pointeur du noeud actuel vers son parent si possible.

Renvoie:
true si le noeud pointe désormais sur l'élément parent, false s'il n'y a pas d'élément parent.
Voir également:
goToChildElement goToNextElement

Définition à la ligne 106 du fichier xml_node.cpp.

Références getElementName(), et node.

Voici le graphe d'appel pour cette fonction :


Documentation des données membres

rapidxml::xml_node<char>* xmlioserver::xml::CXMLNode::node [private]

Pointeur sur un objet de type noeud dans la bibliothèque rapidxml.

Définition à la ligne 156 du fichier xml_node.hpp.

Référencé par getAttributes(), getElementName(), goToChildElement(), goToNextElement(), et goToParentElement().

std::string xmlioserver::xml::CXMLNode::RootName [static, private]

Nom de l'élément racine du document xml.

Définition à la ligne 161 du fichier xml_node.hpp.


La documentation de cette classe a été générée à partir des fichiers suivants :
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Définition de type Amis Macros