Salome HOME
DCQ : Merge with Ecole_Ete_a6.
[modules/kernel.git] / idl / SALOME_Component.idl
index f5fe50f56bef64f89622060c784d36b5f62271b8..a18580fe7f4e2bd9b93d3f6d71c646058099d01f 100644 (file)
@@ -1,15 +1,31 @@
-//=============================================================================
-// File      : SALOME_Component.idl
-// Created   : jeu jui 12 08:11:23 CEST 2001
-// Author    : Paul RASCLE, EDF
-// Project   : SALOME
-// Copyright : EDF 2001
-// $Header: /dn05/salome/CVS/SALOME_ROOT/idl/SALOME_Component.idl
-//=============================================================================
+//  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
+//  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS 
+// 
+//  This library is free software; you can redistribute it and/or 
+//  modify it under the terms of the GNU Lesser General Public 
+//  License as published by the Free Software Foundation; either 
+//  version 2.1 of the License. 
+// 
+//  This library is distributed in the hope that it will be useful, 
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of 
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
+//  Lesser General Public License for more details. 
+// 
+//  You should have received a copy of the GNU Lesser General Public 
+//  License along with this library; if not, write to the Free Software 
+//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA 
+// 
+//  See http://www.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org 
+//
+//
+//
+//  File   : SALOME_Component.idl
+//  Author : Paul RASCLE, EDF
+//  $Header: /dn05/salome/CVS/SALOME_ROOT/idl/SALOME_Component.idl
 
 #ifndef _SALOME_COMPONENT_IDL_
 #define _SALOME_COMPONENT_IDL_
-/*!  \ingroup Kernel 
+/*!  
 
 This is a package of interfaces used for connecting new components to %SALOME application. It also contains a set of interfaces used
 for management of %MED component in %SALOME application.
@@ -21,12 +37,14 @@ module Engines
 /*! \brief Interface of the %Container
 
    This interface defines the process of loading and registration
-    of new components in SALOME application
+    of new components in %SALOME application
 */
   interface Container
   {
 /*!
     Initializes the %container with a definite name.
+    \param ContainerName Name of the container
+    \return an initialized container
 */
     Container start_impl( in string ContainerName ) ;
 
@@ -34,11 +52,13 @@ module Engines
     Loads into the container a new component, registers it and starts it's CORBA servant.
     \param nameToRegister     Name of the component which will be registered in Registry (or Name Service)
     \param componentName     Name of the constructed library of the %component
+    \return a loaded component
 */
     Component load_impl(in string nameToRegister, in string componentName);
 
 /*!
-       Stops the component servant, and deletes all related objects
+    Stops the component servant, and deletes all related objects
+    \param component_i     Component to be removed
 */
     void remove_impl(in Component component_i);
 
@@ -63,6 +83,14 @@ module Engines
    Returns True if the %container has been killed
 */
     boolean Kill_impl() ;
+/*!
+   Returns the hostname of the container
+*/
+    string getHostName();
+/*!
+   Returns the PID of the container
+*/
+    long getPID();
   };
 /*! \brief Interface of the %component
 
@@ -93,6 +121,8 @@ module Engines
     Container GetContainerRef() ;
 /*!
    This method is used by the %SUPERVISOR component. It sets the names of the graph and of the node.
+   \param aGraphName Name of graph
+   \param aNodeName Name of node
 */
     void Names( in string aGraphName , in string aNodeName ) ;
 /*!
@@ -111,6 +141,10 @@ module Engines
    Returns True if the activity of the %Component has been resumed.
 */
     boolean Resume_impl() ;
+/*!
+   Returns the Cpu used (long does not run with python !...)
+*/
+    long CpuUsed_impl() ;
   } ;
 } ;