idl/SALOME_PACOExtension.idl

   1 // Copyright (C) 2007-2023  CEA, EDF, 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, or (at your option) any later version.
   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
  23 #ifndef _SALOME_PACOExtension_IDL_
  24 #define _SALOME_PACOExtension_IDL_
  25
  26 /*! \file SALOME_PACOExtension.idl
  27     \brief Interfaces for Parallel Component and Container using PaCO++
  28 */
  29
  30 #include "SALOME_Component.idl"
  31 #include "DSC_Engines.idl"
  32
  33 module Engines
  34 {
  35   interface Parallel_Component : Engines::EngineComponent {
  36     void send_parallel_proxy_object(in Object proxy_ref);
  37   };
  38
  39   interface PACO_Container : Engines::Container {
  40     // Replicated Method used by the proxy to create
  41     // a PACO Component
  42     void create_paco_component_node_instance(in string registeredName,
  43                                              in string proxy_containerName) raises(SALOME::SALOME_Exception);
  44
  45     void updateInstanceNumber();
  46   };
  47
  48 /*--------------------------------------------------------------------------------------------*/
  49
  50   /*! \brief Interface of a Parallel_DSC component.
  51     This interface defines the operations needed to add a paco++ port
  52     into a parallel DSC component.
  53   */
  54   interface Parallel_DSC : Engines::Superv_Component, Engines::Parallel_Component {
  55
  56     /*!
  57       This operation gives the proxy node of a paco++ port to all the nodes.
  58       Only a node of the parallel component is going to add a proxy object
  59       with an internal method.
  60
  61       \param ref provides proxy port's reference.
  62       \param provides_port_name provides port's name.
  63
  64       \see Engines_ParallelDSC_i::add_parallel_provides_proxy_port
  65      */
  66     void set_paco_proxy(in Object ref,
  67                         in string provides_port_name,
  68                         in Ports::PortProperties port_prop);
  69
  70   };
  71
  72   /*! \brief Interface of a Parallel_Salome_file
  73     This interface is used by parallel components and containers.
  74     It adds methods to enable to choose on which node of the parallel component the file has to
  75     be received.
  76   */
  77   interface Parallel_Salome_file : Engines::Salome_file {
  78
  79     /*!
  80       Set a number of node for the file. Default is the node 0.
  81
  82       \param file_name name of the file.
  83       \param node_nbr node number where the file is.
  84
  85       \exception raised if the file doesn't exist.
  86     */
  87     void setFileNode(in string file_name, in long node_nbr) raises (SALOME::SALOME_Exception);
  88
  89     /*!
  90       Get the number of the node that actually managed the file.
  91
  92       \param file_name name of managed file.
  93
  94       \return node number of the file
  95
  96       \exception raised if the file doesn't exist.
  97      */
  98     long getFileNode(in string file_name) raises (SALOME::SALOME_Exception);
  99
 100     /*!
 101       This method update the state of file for the Parallel_Salome_file.
 102
 103       \param new_file the new state of file.
 104      */
 105     Engines::Container updateFile(in Engines::file new_file);
 106
 107     /*!
 108       This method is used by the parallel implementation of recvFiles.
 109
 110       \exception raised if the file cannot be ok.
 111      */
 112     void recvFiles_node() raises (SALOME::SALOME_Exception);
 113   };
 114 };
 115
 116 #endif