src/XAO/XAO_XaoExporter.hxx

   1 // Copyright (C) 2013-2015  CEA/DEN, EDF R&D, OPEN CASCADE
   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, or (at your option) any later version.
   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.hxx"
  25 #include "XAO_Xao.hxx"
  26 #include "XAO_Geometry.hxx"
  27 #include "XAO_Group.hxx"
  28 #include "XAO_Field.hxx"
  29
  30 #ifdef WIN32
  31 #pragma warning(disable:4290) // Warning Exception ...
  32 #endif
  33
  34 namespace XAO
  35 {
  36     /**
  37      * @class XaoExporter
  38      * Util class for import/export XAO.
  39      */
  40     class XAO_EXPORT XaoExporter
  41     {
  42     public:
  43         /**
  44          * Saves the XAO object to a file.
  45          * @param xaoObject the object to export.
  46          * @param fileName the path of the file to create.
  47          * @return true if the export was successful, false otherwise.
  48          */
  49         static const bool saveToFile(Xao* xaoObject, const std::string& fileName)
  50         throw (XAO_Exception);
  51
  52         /**
  53          * Saves the XAO object to a XML string.
  54          * @param xaoObject the object to export.
  55          * @return the XML string.
  56          */
  57         static const std::string saveToXml(Xao* xaoObject)
  58         throw (XAO_Exception);
  59
  60         /**
  61          * Reads a XAO object from a file.
  62          * @param fileName the path of the file to read.
  63          * @param xaoObject the XAO object.
  64          * @return true if the XAO object was read successful, false otherwise.
  65          */
  66         static const bool readFromFile(const std::string& fileName, Xao* xaoObject)
  67         throw (XAO_Exception);
  68
  69         /**
  70          * Reads a XAO object from an XML string.
  71          * @param xml the XML string.
  72          * @param xaoObject the XAO object.
  73          * @return true if the XAO object was read successful, false otherwise.
  74          */
  75         static const bool setXML(const std::string& xml, Xao* xaoObject)
  76         throw (XAO_Exception);
  77     };
  78 }
  79
  80
  81 #endif /* __XAO_XAOEXPORTER_HXX__ */