1 //=============================================================================
2 // File : SALOME_Component.idl
3 // Created : jeu jui 12 08:11:23 CEST 2001
4 // Author : Paul RASCLE, EDF
6 // Copyright : EDF 2001
7 // $Header: /dn05/salome/CVS/SALOME_ROOT/idl/SALOME_Component.idl
8 //=============================================================================
10 #ifndef _SALOME_COMPONENT_IDL_
11 #define _SALOME_COMPONENT_IDL_
14 This is a package of interfaces used for connecting new components to %SALOME application. It also contains a set of interfaces used
15 for management of %MED component in %SALOME application.
21 /*! \brief Interface of the %Container
23 This interface defines the process of loading and registration
24 of new components in SALOME application
29 Initializes the %container with a definite name.
31 Container start_impl( in string ContainerName ) ;
34 Loads into the container a new component, registers it and starts it's CORBA servant.
35 \param nameToRegister Name of the component which will be registered in Registry (or Name Service)
36 \param componentName Name of the constructed library of the %component
38 Component load_impl(in string nameToRegister, in string componentName);
41 Stops the component servant, and deletes all related objects
43 void remove_impl(in Component component_i);
46 Discharges all components from the container.
48 void finalize_removal() ;
50 Determines whether the server has been loaded or not.
55 Name of the %container
57 readonly attribute string name ;
59 Name of the machine containing this container (location of the container).
61 readonly attribute string machineName ;
63 Returns True if the %container has been killed
67 /*! \brief Interface of the %component
69 This interface is used for interaction between the %container and the %component and between
70 the components inside the container.
75 The name of the instance of the %Component
77 readonly attribute string instanceName ;
79 The name of the interface of the %Component
81 readonly attribute string interfaceName ;
83 Determines whether the server has already been loaded or not.
87 Deactivates the %Component.
91 Returns the container that the %Component refers to.
93 Container GetContainerRef() ;
95 This method is used by the %SUPERVISOR component. It sets the names of the graph and of the node.
97 void Names( in string aGraphName , in string aNodeName ) ;
99 Returns True if the %Component has been killed.
101 boolean Kill_impl() ;
103 Returns True if the activity of the %Component has been stopped. (It's action can't be resumed)
105 boolean Stop_impl() ;
107 Returns True if the activity of the %Component has been suspended. (It's action can be resumed)
109 boolean Suspend_impl() ;
111 Returns True if the activity of the %Component has been resumed.
113 boolean Resume_impl() ;