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
26 #ifndef _SALOME_COMPONENT_IDL_
27 #define _SALOME_COMPONENT_IDL_
29 This is a package of interfaces used for connecting new components to %SALOME
30 application. It also contains a set of interfaces used for management of %MED
31 component in %SALOME application.
36 A byte stream which is used for binary data transfer between different
39 typedef sequence<octet> TMPFile;
42 General Key Value Structure to set or get properties, for component
50 typedef sequence<KeyValuePair> FieldsDict;
54 /*! \brief Interface of the %Container
55 This interface defines the process of loading and registration
56 of new components in %SALOME application
63 Loads a new component class (dynamic library).
64 \param componentName like COMPONENT, (Python or C++ implementation)
65 try to make a Python import of COMPONENT,
66 then a lib open of libCOMPONENTEngine.so
67 \return true if load successfull or already done, false otherwise
69 boolean load_component_Library(in string componentName);
72 Creates a new servant instance of a component.
73 Component library must be loaded.
74 \param componentName Name of the component which will be registered
75 in Registry and Name Service,
76 (instance number suffix added to the registered name)
77 \param studyId 0 if instance is not associated to a study,
78 >0 otherwise (== study id)
79 \return a loaded component
81 Component create_component_instance(in string componentName,
85 Finds a servant instance of a component
86 \param registeredName Name of the component in Registry or Name Service,
87 without instance suffix number
88 \param studyId 0 if instance is not associated to a study,
89 >0 otherwise (== study id)
90 \return the first instance found with same studyId
92 Component find_component_instance(in string registeredName,
96 Find a servant instance of a component, or create a new one.
97 Loads the component library if needed.
98 Only applicable to multiStudy components.
99 \param nameToRegister Name of the component which will be registered
100 in Registry (or Name Service)
101 \param componentName Name of the constructed library of the %component
102 (not used any more, give empty string)
103 \return a loaded component
105 Component load_impl(in string nameToRegister,
106 in string componentName);
109 Stops the component servant, and deletes all related objects
110 \param component_i Component to be removed
112 void remove_impl(in Component component_i);
115 Discharges all components from the container.
117 void finalize_removal() ;
120 Determines whether the server has been loaded or not.
125 Name of the %container
127 readonly attribute string name ;
130 Shutdown the Container process.
132 oneway void Shutdown();
135 Returns the hostname of the container
137 string getHostName();
140 Returns the PID of the container
145 Returns True if the %container has been killed.
146 Kept for Superv compilation but can't work, unless oneway...
149 boolean Kill_impl() ;
151 // -------------------------- removed -------------------------------
154 Loads into the container a new component, registers it and starts it's
156 \param nameToRegister Name used to register in Naming Service,
157 the component instance
158 \param componentName Name of the %component
159 \return a new instance of the component or the registered component
160 if already registered or Nil if not possible
162 // Component instance(in string nameToRegister, in string componentName);
166 Name of the machine containing this container (location of the container).
168 // readonly attribute string machineName ;
175 /*! \brief Interface of the %component
176 This interface is used for interaction between the %container and the
177 %component and between the components inside the container.
182 The name of the instance of the %Component
184 readonly attribute string instanceName ;
187 The name of the interface of the %Component
189 readonly attribute string interfaceName ;
192 Determines whether the server has already been loaded or not.
197 // Set study associated to component instance
199 // (=0: multistudy component instance,
200 // >0: study id associated to this instance
201 // \return false if already set with a different value (change not possible)
203 // boolean setStudyId(in long studyId);
206 get study associated to component instance
207 \return -1: not initialised (Internal Error)
208 0: multistudy component instance
209 >0: study id associated to this instance
214 Deactivates the %Component.
215 -- TO BE USED BY CONTAINER ONLY (Container housekeeping) --
216 use remove_impl from Container instead !
221 Returns the container that the %Component refers to.
223 Container GetContainerRef() ;
226 Gives a sequence of (key=string,value=any) to the component.
227 Base class component stores the sequence in a map.
228 The map is cleared before.
229 This map is for use by derived classes.
231 void setProperties(in FieldsDict dico);
234 returns a previously stored map (key=string,value=any) as a sequence.
235 See setProperties(in FieldsDict dico).
237 FieldsDict getProperties();
240 This method is used by the %SUPERVISOR component. It sets the names of
241 the graph and of the node.
242 \param aGraphName Name of graph
243 \param aNodeName Name of node
245 void Names( in string aGraphName , in string aNodeName ) ;
248 Returns True if the %Component has been killed.
250 boolean Kill_impl() ;
253 Returns True if the activity of the %Component has been stopped.
254 (It's action can't be resumed)
256 boolean Stop_impl() ;
259 Returns True if the activity of the %Component has been suspended.
260 (It's action can be resumed)
262 boolean Suspend_impl() ;
265 Returns True if the activity of the %Component has been resumed.
267 boolean Resume_impl() ;
270 Returns the Cpu used (long does not run with python !...)
272 long CpuUsed_impl() ;
275 Returns a python script, which is being played back reproduces
276 the data model of component
278 TMPFile DumpPython(in Object theStudy,
279 in boolean isPublished,
280 out boolean isValidScript);