Salome HOME
Fix regression: killSalomeWithPort does not kill sessions of the old versions of...
[modules/kernel.git] / idl / SALOME_PACOExtension.idl
1 //  Copyright (C) 2007-2010  CEA/DEN, EDF R&D, OPEN CASCADE
2 //
3 //  This library is free software; you can redistribute it and/or
4 //  modify it under the terms of the GNU Lesser General Public
5 //  License as published by the Free Software Foundation; either
6 //  version 2.1 of the License.
7 //
8 //  This library is distributed in the hope that it will be useful,
9 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
10 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11 //  Lesser General Public License for more details.
12 //
13 //  You should have received a copy of the GNU Lesser General Public
14 //  License along with this library; if not, write to the Free Software
15 //  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
16 //
17 //  See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
18 //
19
20 //  File   : SALOME_PACOExtension.idl
21 //  Author : AndrĂ© RIBES, EDF
22 //  $Header: 
23 //
24 #ifndef _SALOME_PACOExtension_IDL_
25 #define _SALOME_PACOExtension_IDL_
26
27 /*! \file SALOME_PACOExtension.idl 
28     \brief Interfaces for Parallel Component and Container using PaCO++
29 */
30
31 #include "SALOME_Component.idl"
32 #include "DSC_Engines.idl"
33
34 module Engines
35 {
36   interface Parallel_Component : Engines::Component {
37     void send_parallel_proxy_object(in Object proxy_ref);
38   };
39
40   interface PACO_Container : Engines::Container {
41     // Replicated Method used by the proxy to create
42     // a PACO Component
43     void create_paco_component_node_instance(in string registeredName,
44                                              in string proxy_containerName,
45                                              in long studyId) raises(SALOME::SALOME_Exception);
46
47     void updateInstanceNumber();
48   };
49
50 /*--------------------------------------------------------------------------------------------*/
51
52   /*! \brief Interface of a Parallel_DSC component.
53     This interface defines the operations needed to add a paco++ port 
54     into a parallel DSC component.
55   */
56   interface Parallel_DSC : Engines::Superv_Component, Engines::Parallel_Component {
57
58     /*!
59       This operation gives the proxy node of a paco++ port to all the nodes.
60       Only a node of the parallel component is going to add a proxy object 
61       with an internal method.
62
63       \param ref provides proxy port's reference.
64       \param provides_port_name provides port's name.
65
66       \see Engines_ParallelDSC_i::add_parallel_provides_proxy_port
67      */
68     void set_paco_proxy(in Object ref, 
69                         in string provides_port_name,
70                         in Ports::PortProperties port_prop);
71                         
72   };  
73
74   /*! \brief Interface of a Parallel_Salome_file
75     This interface is used by parallel components and containers.
76     It adds methods to enable to choose on which node of the parallel component the file has to 
77     be received.
78   */
79   interface Parallel_Salome_file : Engines::Salome_file {
80
81     /*!
82       Set a number of node for the file. Default is the node 0.
83
84       \param file_name name of the file.
85       \param node_nbr node number where the file is.
86
87       \exception raised if the file doesn't exist.
88     */
89     void setFileNode(in string file_name, in long node_nbr) raises (SALOME::SALOME_Exception);
90
91     /*!
92       Get the number of the node that actually managed the file.
93
94       \param file_name name of managed file.
95
96       \return node number of the file
97
98       \exception raised if the file doesn't exist.
99      */
100     long getFileNode(in string file_name) raises (SALOME::SALOME_Exception);
101
102     /*!
103       This method update the state of file for the Parallel_Salome_file. 
104
105       \param new_file the new state of file.
106      */
107     Engines::Container updateFile(in Engines::file new_file);
108
109     /*!
110       This method is used by the parallel implementation of recvFiles.
111
112       \exception raised if the file cannot be ok.
113      */
114     void recvFiles_node() raises (SALOME::SALOME_Exception);
115   };
116 };
117
118 #endif