idl/SALOME_PACOExtension.idl

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