src/evalyfx/YACSEvalYFX.hxx

   1 // Copyright (C) 2012-2020  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 // Author : Anthony Geay (EDF R&D)
  20
  21 #ifndef __YACSEVALYFX_HXX__
  22 #define __YACSEVALYFX_HXX__
  23
  24 #include "YACSEvalYFXExport.hxx"
  25 #include "YACSEvalExecParams.hxx"
  26
  27 #include <string>
  28 #include <vector>
  29
  30 namespace YACS
  31 {
  32   namespace ENGINE
  33   {
  34     class Proc;
  35   }
  36 }
  37
  38 class YACSEvalObserver;
  39 class YACSEvalSeqAny;
  40 class YACSEvalSession;
  41 class YACSEvalYFXPattern;
  42 class YACSEvalInputPort;
  43 class YACSEvalOutputPort;
  44 class YACSEvalListOfResources;
  45
  46 class YACSEvalYFX
  47 {
  48 public:
  49   YACSEVALYFX_EXPORT static YACSEvalYFX *BuildFromFile(const std::string& xmlOfScheme);
  50   YACSEVALYFX_EXPORT static YACSEvalYFX *BuildFromScheme(YACS::ENGINE::Proc *scheme);
  51   YACSEVALYFX_EXPORT YACSEvalExecParams *getParams() const { return &_params; }
  52   YACSEVALYFX_EXPORT std::vector< YACSEvalInputPort * > getFreeInputPorts() const;
  53   YACSEVALYFX_EXPORT std::vector< YACSEvalOutputPort * > getFreeOutputPorts() const;
  54   YACSEVALYFX_EXPORT void lockPortsForEvaluation(const std::vector< YACSEvalInputPort * >& inputsOfInterest, const std::vector< YACSEvalOutputPort * >& outputsOfInterest);
  55   YACSEVALYFX_EXPORT void unlockAll();
  56   YACSEVALYFX_EXPORT bool isLocked() const;
  57   YACSEVALYFX_EXPORT YACSEvalListOfResources *giveResources();
  58   YACSEVALYFX_EXPORT bool run(YACSEvalSession *session, int& nbOfBranches);
  59   YACSEVALYFX_EXPORT void registerObserver(YACSEvalObserver *observer);
  60   YACSEVALYFX_EXPORT YACSEvalObserver *getObserver();
  61   YACSEVALYFX_EXPORT std::string getErrorDetailsInCaseOfFailure() const;
  62   YACSEVALYFX_EXPORT std::string getStatusOfRunStr() const;
  63   YACSEVALYFX_EXPORT std::vector<YACSEvalSeqAny *> getResults() const;
  64   YACSEVALYFX_EXPORT std::vector<YACSEvalSeqAny *> getResultsInCaseOfFailure(std::vector<unsigned int>& passedIds) const;
  65   //
  66   YACSEVALYFX_EXPORT YACS::ENGINE::Proc *getUndergroundGeneratedGraph() const;
  67   YACSEVALYFX_EXPORT void setParallelizeStatus(bool newVal);
  68   YACSEVALYFX_EXPORT bool getParallelizeStatus() const;
  69   YACSEVALYFX_EXPORT ~YACSEvalYFX();
  70 private:
  71   YACSEvalYFX(YACS::ENGINE::Proc *scheme, bool ownScheme);
  72   void checkPortsForEvaluation(const std::vector< YACSEvalInputPort * >& inputs, const std::vector< YACSEvalOutputPort * >& outputs) const;
  73 private:
  74   YACSEvalYFXPattern *_pattern;
  75   mutable YACSEvalExecParams _params;
  76 };
  77
  78 #endif