]> SALOME platform Git repositories - modules/kernel.git/blob - idl/SALOME_PyNode.idl
Salome HOME
#19007 [CEA][Windows] SALOME non regression tests on Windows: fix KERNEL_SALOME_COMMA...
[modules/kernel.git] / idl / SALOME_PyNode.idl
1 // Copyright (C) 2007-2020  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
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
30 /*! \file SALOME_PyNode.idl \brief interface for remote python execution
31 */
32
33 /*! \brief
34 This is a package of interfaces used for executing Python code on remote container
35 */
36 module Engines
37 {
38   typedef sequence<octet> pickledArgs;
39   typedef sequence<string> listofstring;
40   interface Container;
41
42   interface PyNodeBase : SALOME::GenericObj
43   {
44     Container getContainer();
45
46     string getCode();
47
48     string getName();
49
50     /*!
51       This method allows to define a new global var called \a varName. This newly created var will be
52       set to value \a valueOfVar.
53      */
54     void defineNewCustomVar(in string varName, in pickledArgs valueOfVar) raises (SALOME::SALOME_Exception);
55
56     /*!
57     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.
58     \param [in] codeStr - the python code (without statement) to be executed, that can modify the context initialized at initialization.
59      */
60     void executeAnotherPieceOfCode(in string codeStr) raises (SALOME::SALOME_Exception);
61   };
62
63   interface PyNode : PyNodeBase
64   {
65     /*! \brief execute a python function defined in the node
66
67       \param functionName the python function defined in the node to execute
68       \param inargs input argument values (tuple,dict) provided as a python pickle
69       \return output argument values (tuple) as a python pickle
70     */
71     pickledArgs execute(in string functionName, in pickledArgs inargs) raises (SALOME::SALOME_Exception);
72
73   } ;
74
75   interface PyScriptNode : PyNodeBase
76   {
77     /*!
78       This method compiles, but NOT EXECUTE, the code \a codeStr. The result of the compiled code will be used then
79       on execute step.
80       \param codeStr - the python code (without statement) to be executed, that can modify the context initialized at initialization.
81      */
82     void assignNewCompiledCode(in string codeStr) raises (SALOME::SALOME_Exception);
83
84     /*! \brief execute a python script defined in the node
85
86       \param outargsname output argument names 
87       \param inargs input argument values (dict) provided as a python pickle
88       \return output argument values (tuple) as a python pickle
89     */
90     pickledArgs execute(in listofstring outargsname, in pickledArgs inargs) raises (SALOME::SALOME_Exception);
91
92     /*! \brief first part of whole execute method. This split is to reduce the memory peak.
93     */
94     void executeFirst(in pickledArgs inargs) raises (SALOME::SALOME_Exception);
95
96     /*! \brief second and last part of execute method. This split is to reduce the memory peak.
97     */
98     pickledArgs executeSecond(in listofstring outargsname) raises (SALOME::SALOME_Exception);
99
100     pickledArgs getValueOfVarInContext(in string varName) raises (SALOME::SALOME_Exception);
101
102     void assignVarInContext(in string varName, in pickledArgs value) raises (SALOME::SALOME_Exception);
103
104     pickledArgs callMethodOnVarInContext(in string varName, in string methodName, in pickledArgs args) raises (SALOME::SALOME_Exception);
105   } ;
106
107 };
108
109 #endif