src/XAO/XAO_XaoExporter.hxx

   1 // Copyright (C) 2013  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19 // Author : Frederic Pons (OpenCascade)
  20
  21 #ifndef __XAO_XAOEXPORTER_HXX__
  22 #define __XAO_XAOEXPORTER_HXX__
  23
  24 #include "XAO_Xao.hxx"
  25 #include "XAO_Geometry.hxx"
  26 #include "XAO_Group.hxx"
  27 #include "XAO_Field.hxx"
  28
  29 namespace XAO
  30 {
  31     /**
  32      * @class XaoExporter
  33      * Util class for import/export XAO.
  34      */
  35     class XaoExporter
  36     {
  37     public:
  38         /**
  39          * Saves the XAO object to a file.
  40          * @param xaoObject the object to export.
  41          * @param fileName the path of the file to create.
  42          * @return true if the export was successful, false otherwise.
  43          */
  44         static const bool saveToFile(Xao* xaoObject, const std::string& fileName)
  45         throw (XAO_Exception);
  46
  47         /**
  48          * Saves the XAO object to a XML string.
  49          * @param xaoObject the object to export.
  50          * @return the XML string.
  51          */
  52         static const std::string saveToXml(Xao* xaoObject)
  53         throw (XAO_Exception);
  54
  55         /**
  56          * Reads a XAO object from a file.
  57          * @param fileName the path of the file to read.
  58          * @param xaoObject the XAO object.
  59          * @return true if the XAO object was read successful, false otherwise.
  60          */
  61         static const bool readFromFile(const std::string& fileName, Xao* xaoObject)
  62         throw (XAO_Exception);
  63
  64         /**
  65          * Reads a XAO object from an XML string.
  66          * @param xml the XML string.
  67          * @param xaoObject the XAO object.
  68          * @return true if the XAO object was read successful, false otherwise.
  69          */
  70         static const bool setXML(const std::string& xml, Xao* xaoObject)
  71         throw (XAO_Exception);
  72     };
  73 }
  74
  75
  76 #endif /* __XAO_XAOEXPORTER_HXX__ */