source: XMLIO_V2/dev/dev_rv/src4/xmlio/xml/xml_parser.hpp @ 215

Last change on this file since 215 was 215, checked in by hozdoba, 10 years ago
File size: 2.6 KB
Line 
1/* ************************************************************************** *
2 *      Copyright © IPSL/LSCE, XMLIOServer, Avril 2010 - Octobre 2011         *
3 * ************************************************************************** */
4
5#ifndef __XML_PARSER_HPP__
6#define __XML_PARSER_HPP__
7
8/**
9 * \file    xml_parser.hpp
10 * \brief   Définition des méthodes d'initialisation du parsing xml (entête).
11 * \author  Hervé Ozdoba
12 * \version 0.4
13 * \date    12 Juin 2011
14 */
15
16// C++ standard headers
17#include <string>
18#include <iostream>
19
20// XMLIOServer headers
21#include "xml_node.hpp"
22
23// ////////////////////////////// Déclarations ///////////////////////////// //
24
25namespace xmlioserver
26{
27   /// \brief Espace de nommage incluant les classes de manipulation du format xml.
28   namespace xml
29   {
30      /**
31       * \class CXMLParser
32       * \brief Classe de traitement de document xml depuis différentes sources de données.
33       */
34      class CXMLParser
35      {
36         public : // Méthodes statiques
37
38            /*!
39             * \brief Parse un document xml à partir d'un nom de fichier.
40             * \param _filename : le nom d'un fichier contenant l'arborescence xml.
41             * \see ParseString ParseStream
42             *
43             * Cette méthode utilise ParseStream de la maniÚre suivante :
44             * \code
45             * //> Parsing d'un flux d'entrée de fichier.
46             * std::ifstream ifs ( _filename.c_str() , std::ifstream::in );
47             * CXMLParser::ParseStream(ifs);
48             * \endcode
49             */
50            static void ParseFile  (const std::string & _filename);
51
52            /*!
53             * \brief Parse un document xml à partir d'une chaîne de caractÚres.
54             * \param _xmlContent : une chaîne de caractÚres contenant l'arborescence xml.
55             * \see ParseFile ParseStream
56             *
57             * Cette méthode utilise ParseStream de la maniÚre suivante :
58             * \code
59             * //> Parsing d'un flux d'entrée de chaîne de caractÚres.
60             * StdIStringStream iss(_xmlContent);
61             * CXMLParser::ParseStream(iss);
62             * \endcode
63             */
64            static void ParseString(const std::string & _xmlContent);
65
66            /*!
67             * \brief Parse un document xml à partir d'un flux d'entrée de données.
68             * \param _stream : le flux d'entrée contenant l'arborescence xml.
69             * \see ParseString ParseFile
70             */
71            static void ParseStream(std::istream & _stream);
72
73      }; //class CXMLParser
74
75   }// namespace xml
76} // namespace xmlioserver
77
78#endif // __XML_PARSER_HPP__
79
Note: See TracBrowser for help on using the repository browser.