idl/SALOME_GenericObj.idl

   1 // Copyright (C) 2007-2023  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License, or (at your option) any later version.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 //  File   : SALOME_Component.idl
  24 //  Author : Alexey Petrov, OPEN CASCADE
  25 //  $Header$
  26 //
  27 #ifndef _SALOME_GENERICOBJ_IDL_
  28 #define _SALOME_GENERICOBJ_IDL_
  29
  30 /*! \file SALOME_GenericObj.idl \brief interface for common behavior of %SALOME transient CORBA objects
  31 */
  32
  33 module SALOME {
  34
  35   typedef sequence<string> StringSeq;
  36
  37   /*!
  38     \brief interface for common behavior of %SALOME transient CORBA objects
  39   */
  40   interface GenericObj {
  41     /*! \brief Increase the reference count (mark as used by another object).*/
  42     void Register();
  43     /*! \brief Decrease the reference count (release by another object).*/
  44     void UnRegister();
  45     /*! \brief Obsolete, left for compatibility reasons only. Use UnRegister() instead.*/
  46     void Destroy();
  47   };
  48
  49   /*!
  50     \brief common usage interface for exporting of arbitrary data in %SALOME environment
  51   */
  52   interface ExportableObject : GenericObj {
  53     /*! \brief Get a list of supported formats */
  54     StringSeq GetExportableFormats();
  55     /*! \brief Export data in the specified format */
  56     boolean   ExportDataAs(in string format, out GenericObj exporter);
  57   };
  58 };
  59
  60 #endif