idl/SALOME_Component.idl

   1 //  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   2 //  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   3 //
   4 //  This library is free software; you can redistribute it and/or
   5 //  modify it under the terms of the GNU Lesser General Public
   6 //  License as published by the Free Software Foundation; either
   7 //  version 2.1 of the License.
   8 //
   9 //  This library is distributed in the hope that it will be useful,
  10 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 //  Lesser General Public License for more details.
  13 //
  14 //  You should have received a copy of the GNU Lesser General Public
  15 //  License along with this library; if not, write to the Free Software
  16 //  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  17 //
  18 //  See http://www.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
  19 //
  20 //
  21 //
  22 //  File   : SALOME_Component.idl
  23 //  Author : Paul RASCLE, EDF
  24 //  $Header: /dn05/salome/CVS/SALOME_ROOT/idl/SALOME_Component.idl
  25
  26 #ifndef _SALOME_COMPONENT_IDL_
  27 #define _SALOME_COMPONENT_IDL_
  28 /*!
  29
  30 This is a package of interfaces used for connecting new components to %SALOME application. It also contains a set of interfaces used
  31 for management of %MED component in %SALOME application.
  32 */
  33 module Engines
  34 {
  35 /*!
  36     General Key Value Structure to set or get properties, for component
  37 */
  38   struct KeyValuePair
  39   {
  40     string key;
  41     any value;
  42   };
  43
  44   typedef sequence<KeyValuePair> FieldsDict;
  45
  46   interface Component ;
  47
  48 /*! \brief Interface of the %Container
  49
  50    This interface defines the process of loading and registration
  51     of new components in %SALOME application
  52 */
  53   interface Container
  54   {
  55 /*!
  56     Initializes the %container with a definite name.
  57     \param ContainerName Name of the container
  58     \return an initialized container
  59 */
  60     Container start_impl( in string ContainerName ) ;
  61
  62 /*!
  63     Loads into the container a new component, registers it and starts it's CORBA servant.
  64     \param nameToRegister     Name of the component which will be registered in Registry (or Name Service)
  65     \param componentName     Name of the constructed library of the %component
  66     \return a loaded component
  67 */
  68     Component load_impl(in string nameToRegister, in string componentName);
  69
  70 /*!
  71     Stops the component servant, and deletes all related objects
  72     \param component_i     Component to be removed
  73 */
  74     void remove_impl(in Component component_i);
  75
  76 /*!
  77     Discharges all components from the container.
  78 */
  79     void finalize_removal() ;
  80 /*!
  81      Determines whether the server has been loaded or not.
  82 */
  83
  84     void ping();
  85 /*!
  86    Name of the %container
  87 */
  88     readonly attribute string name ;
  89 /*!
  90    Name of the machine containing this container (location of the container).
  91 */
  92     readonly attribute string machineName ;
  93 /*!
  94    Returns True if the %container has been killed
  95 */
  96     boolean Kill_impl() ;
  97 /*!
  98    Returns the hostname of the container
  99 */
 100     string getHostName();
 101 /*!
 102    Returns the PID of the container
 103 */
 104     long getPID();
 105   };
 106 /*! \brief Interface of the %component
 107
 108     This interface is used for interaction between the %container and the %component and between
 109     the components inside the container.
 110 */
 111   interface Component
 112   {
 113 /*!
 114    The name of the instance of the %Component
 115 */
 116     readonly attribute string instanceName ;
 117 /*!
 118    The name of the interface of the %Component
 119 */
 120     readonly attribute string interfaceName ;
 121 /*!
 122     Determines whether the server has already been loaded or not.
 123 */
 124     void ping();
 125 /*!
 126     Deactivates the %Component.
 127 */
 128     void destroy() ;
 129 /*!
 130     Returns the container that the %Component refers to.
 131 */
 132     Container GetContainerRef() ;
 133 /*!
 134     Gives a sequence of (key=string,value=any) to the component.
 135     Base class component stores the sequence in a map.
 136     The map is cleared before.
 137     This map is for use by derived classes.
 138 */
 139     void setProperties(in FieldsDict dico);
 140 /*!
 141     returns a previously stored map (key=string,value=any) as a sequence.
 142     See setProperties(in FieldsDict dico).
 143 */
 144     FieldsDict getProperties();
 145 /*!
 146    This method is used by the %SUPERVISOR component. It sets the names of the graph and of the node.
 147    \param aGraphName Name of graph
 148    \param aNodeName Name of node
 149 */
 150     void Names( in string aGraphName , in string aNodeName ) ;
 151 /*!
 152    Returns True if the %Component has been killed.
 153 */
 154     boolean Kill_impl() ;
 155 /*!
 156    Returns True if the activity of the %Component has been stopped. (It's action can't be resumed)
 157 */
 158     boolean Stop_impl() ;
 159 /*!
 160    Returns True if the activity of the %Component has been suspended. (It's action can be resumed)
 161 */
 162     boolean Suspend_impl() ;
 163 /*!
 164    Returns True if the activity of the %Component has been resumed.
 165 */
 166     boolean Resume_impl() ;
 167 /*!
 168    Returns the Cpu used (long does not run with python !...)
 169 */
 170     long CpuUsed_impl() ;
 171   } ;
 172 } ;
 173
 174 #endif