idl/SALOME_PyNode.idl

   1 // Copyright (C) 2007-2024  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_PyNode.idl
  21 //  Author : Christian CAREMOLI, EDF
  22 //  $Header:
  23 //
  24 #ifndef _SALOME_PYNODE_IDL_
  25 #define _SALOME_PYNODE_IDL_
  26
  27 #include "SALOME_GenericObj.idl"
  28 #include "SALOME_Exception.idl"
  29 #include "SALOME_Comm.idl"
  30
  31 /*! \file SALOME_PyNode.idl \brief interface for remote python execution
  32 */
  33
  34 /*! \brief
  35 This is a package of interfaces used for executing Python code on remote container
  36 */
  37 module Engines
  38 {
  39   typedef sequence<octet> pickledArgs;
  40   typedef sequence<string> listofstring;
  41   interface Container;
  42
  43   interface PyNodeBase : SALOME::GenericObj
  44   {
  45     Container getContainer();
  46
  47     string getCode();
  48
  49     string getName();
  50
  51     /*!
  52       This method allows to define a new global var called \a varName. This newly created var will be
  53       set to value \a valueOfVar.
  54      */
  55     void defineNewCustomVar(in string varName, in pickledArgs valueOfVar) raises (SALOME::SALOME_Exception);
  56
  57     /*!
  58     This method executes the python code in \a codeStr and can append/remove symboles in context to make them available or not for future call of execute on this.
  59     \param [in] codeStr - the python code (without statement) to be executed, that can modify the context initialized at initialization.
  60      */
  61     void executeAnotherPieceOfCode(in string codeStr) raises (SALOME::SALOME_Exception);
  62   };
  63
  64   interface PyNode : PyNodeBase
  65   {
  66     /*! \brief execute a python function defined in the node
  67
  68       \param functionName the python function defined in the node to execute
  69       \param inargs input argument values (tuple,dict) provided as a python pickle
  70       \return output argument values (tuple) as a python pickle
  71     */
  72     pickledArgs execute(in string functionName, in pickledArgs inargs) raises (SALOME::SALOME_Exception);
  73
  74   } ;
  75
  76   interface PyScriptNode : PyNodeBase
  77   {
  78     /*!
  79       This method compiles, but NOT EXECUTE, the code \a codeStr. The result of the compiled code will be used then
  80       on execute step.
  81       \param codeStr - the python code (without statement) to be executed, that can modify the context initialized at initialization.
  82      */
  83     void assignNewCompiledCode(in string codeStr) raises (SALOME::SALOME_Exception);
  84
  85     /*! \brief execute a python script defined in the node
  86
  87       \param outargsname output argument names
  88       \param inargs input argument values (dict) provided as a python pickle
  89       \return output argument values (tuple) as a python pickle
  90     */
  91     pickledArgs execute(in listofstring outargsname, in pickledArgs inargs) raises (SALOME::SALOME_Exception);
  92
  93     void executeSimple(in listofstring key, in listofstring val) raises (SALOME::SALOME_Exception);
  94
  95     /*! \brief first part of whole execute method. This split is to reduce the memory peak.
  96     */
  97     void executeFirst(in SALOME::SenderByte inargs) raises (SALOME::SALOME_Exception);
  98
  99     /*! \brief second and last part of execute method. This split is to reduce the memory peak.
 100     */
 101     SALOME::SenderByteSeq executeSecond(in listofstring outargsname) raises (SALOME::SALOME_Exception);
 102
 103     pickledArgs getValueOfVarInContext(in string varName) raises (SALOME::SALOME_Exception);
 104
 105     void assignVarInContext(in string varName, in pickledArgs value) raises (SALOME::SALOME_Exception);
 106
 107     pickledArgs callMethodOnVarInContext(in string varName, in string methodName, in pickledArgs args) raises (SALOME::SALOME_Exception);
 108
 109     listofstring listAllVarsInContext() raises (SALOME::SALOME_Exception);
 110
 111     void removeAllVarsInContext() raises (SALOME::SALOME_Exception);
 112   } ;
 113
 114 };
 115
 116 #endif