idl/XAOPlugin.idl

   1 // Copyright (C) 2014-2023  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
  20 #ifndef __XAOPlugin_IDL__
  21 #define __XAOPlugin_IDL__
  22
  23 #include "GEOM_Gen.idl"
  24
  25 module GEOM
  26 {
  27   /*!
  28    *  \brief Interface for XAOPlugin modeling functions.
  29    */
  30   interface IXAOOperations : GEOM::GEOM_IOperations
  31   {
  32     /*!
  33      *  Export a shape to XAO format
  34      *  \param shape The shape to export
  35      *  \param groups The list of groups to export
  36      *  \param fields The list of fields to export
  37      *  \param author The author of the export
  38      *  \param fileName The name of the file to export
  39      *  \param shapeFileName The name of the file to export the shape in an external file
  40      *  \return boolean indicating if export was successful.
  41      */
  42     boolean ExportXAO( in GEOM::GEOM_Object shape,
  43                        in GEOM::ListOfGO groups,
  44                        in GEOM::ListOfFields fields,
  45                        in string author,
  46                        in string fileName,
  47                        in string shapeFileName );
  48
  49     /*!
  50      *  Import a shape from XAO format
  51      *  \param fileName The name of the file to import
  52      *  \param shape The imported shape
  53      *  \param subShapes The list of imported subShapes
  54      *  \param groups The list of imported groups
  55      *  \param fields The list of imported fields
  56      *  \return boolean indicating if import was successful.
  57      */
  58     boolean ImportXAO( in string fileName,
  59                        out GEOM::GEOM_Object shape,
  60                        out GEOM::ListOfGO subShapes,
  61                        out GEOM::ListOfGO groups,
  62                        out GEOM::ListOfFields fields );
  63   };
  64 };
  65
  66 #endif // __XAOPlugin_IDL__