1 // Copyright (C) 2003 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
2 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
18 // See http://www.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
22 // File : SALOME_Component.idl
23 // Author : Paul RASCLE, EDF
24 // $Header: /dn05/salome/CVS/SALOME_ROOT/idl/SALOME_Component.idl
26 #ifndef _SALOME_COMPONENT_IDL_
27 #define _SALOME_COMPONENT_IDL_
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.
36 General Key Value Structure to set or get properties, for component
44 typedef sequence<KeyValuePair> FieldsDict;
48 /*! \brief Interface of the %Container
50 This interface defines the process of loading and registration
51 of new components in %SALOME application
57 Loads into the container a new component, registers it and starts it's CORBA servant.
58 \param nameToRegister Name of the component which will be registered in Registry (or Name Service)
59 \param componentName Name of the constructed library of the %component
60 \return a loaded component
62 Component load_impl(in string nameToRegister, in string componentName);
65 Stops the component servant, and deletes all related objects
66 \param component_i Component to be removed
68 void remove_impl(in Component component_i);
71 Discharges all components from the container.
73 void finalize_removal() ;
75 Determines whether the server has been loaded or not.
80 Name of the %container
82 readonly attribute string name ;
84 Name of the machine containing this container (location of the container).
86 readonly attribute string machineName ;
88 Returns True if the %container has been killed
92 Shutdown the Container process.
96 Returns the hostname of the container
100 Returns the PID of the container
104 /*! \brief Interface of the %component
106 This interface is used for interaction between the %container and the %component and between
107 the components inside the container.
112 The name of the instance of the %Component
114 readonly attribute string instanceName ;
116 The name of the interface of the %Component
118 readonly attribute string interfaceName ;
120 Determines whether the server has already been loaded or not.
124 Deactivates the %Component.
128 Returns the container that the %Component refers to.
130 Container GetContainerRef() ;
132 Gives a sequence of (key=string,value=any) to the component.
133 Base class component stores the sequence in a map.
134 The map is cleared before.
135 This map is for use by derived classes.
137 void setProperties(in FieldsDict dico);
139 returns a previously stored map (key=string,value=any) as a sequence.
140 See setProperties(in FieldsDict dico).
142 FieldsDict getProperties();
144 This method is used by the %SUPERVISOR component. It sets the names of the graph and of the node.
145 \param aGraphName Name of graph
146 \param aNodeName Name of node
148 void Names( in string aGraphName , in string aNodeName ) ;
150 Returns True if the %Component has been killed.
152 boolean Kill_impl() ;
154 Returns True if the activity of the %Component has been stopped. (It's action can't be resumed)
156 boolean Stop_impl() ;
158 Returns True if the activity of the %Component has been suspended. (It's action can be resumed)
160 boolean Suspend_impl() ;
162 Returns True if the activity of the %Component has been resumed.
164 boolean Resume_impl() ;
166 Returns the Cpu used (long does not run with python !...)
168 long CpuUsed_impl() ;