idl/yacsgui.idl

   1 // Copyright (C) 2006-2022  CEA/DEN, EDF R&D
   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 #ifndef __YACSGUI_IDL__
  21 #define __YACSGUI_IDL__
  22
  23 #include "SALOME_Component.idl"
  24 #include "SALOMEDS.idl"
  25 #include "SALOME_Exception.idl"
  26
  27   // SALOME Engine interface for execution in a SALOME Container
  28
  29 module YACS_ORB
  30 {
  31   enum executionMode { CONTINUE, STEPBYSTEP, STOPBEFORENODES };
  32
  33   typedef sequence<string> stringArray;
  34   typedef sequence<long> longArray;
  35
  36   interface Observer
  37   {
  38     void notifyObserver(in long numid , in string event);
  39   };
  40
  41   interface ProcExec
  42   {
  43     long getNodeState(in long numid);
  44     string getNodeProgress(in long numid);
  45     string getXMLState(in long numid);
  46     string getInPortValue(in long nodeNumid, in string portName);
  47     string setInPortValue(in string nodeName, in string portName, in string value);
  48     string getOutPortValue(in long nodeNumid, in string portName);
  49     string getErrorDetails(in long nodeNumid);
  50     string getErrorReport(in long nodeNumid);
  51     string getContainerLog(in long nodeNumid);
  52     void shutdownProc(in long level);
  53     long getExecutorState();
  54     void getIds(out longArray numids,out stringArray names);
  55     longArray getNumIds();
  56     stringArray getNames();
  57
  58     void Run();
  59     void RunFromState(in string xmlfile);
  60     void RestartFromState(in string xmlfile);
  61     void addObserver(in Observer obs,in long numid, in string event);
  62     void setExecMode(in executionMode mode);
  63     void setListOfBreakPoints(in stringArray listOfBreakPoints);
  64     stringArray getTasksToLoad();
  65     boolean setStepsToExecute(in stringArray listToExecute);
  66     boolean resumeCurrentBreakPoint();
  67     boolean isNotFinished();
  68     void stopExecution();
  69     boolean saveState(in string xmlFile);
  70     void setStopOnError(in boolean dumpRequested, in string xmlFile);
  71     void unsetStopOnError();
  72   };
  73
  74   interface YACS_Gen : Engines::EngineComponent, SALOMEDS::Driver
  75   {
  76     ProcExec LoadProc(in string xmlFile);
  77     string convertSupervFile(in string xmlFile);
  78   };
  79
  80 };
  81
  82 #endif