src/evalyfx/YACSEvalYFXPattern.hxx

   1 // Copyright (C) 2012-2016  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 __YACSEVALYFXPATTERN_HXX__
  22 #define __YACSEVALYFXPATTERN_HXX__
  23
  24 #include "YACSEvalPort.hxx"
  25
  26 #include <vector>
  27
  28 #ifdef WIN32
  29 #define NOMINMAX
  30 #endif
  31
  32 namespace YACS
  33 {
  34   namespace ENGINE
  35   {
  36     class Proc;
  37     class TypeCode;
  38     class ForEachLoop;
  39     class ComposedNode;
  40     class InputPyPort;
  41     class SequenceAny;
  42   }
  43 }
  44
  45 class YACSEvalYFX;
  46 class YACSEvalSession;
  47 class YACSEvalObserver;
  48 class YACSEvalListOfResources;
  49 class ResourcesManager_cpp;
  50 class YACSEvalYFXRunOnlyPatternInternalObserver;
  51
  52 class YACSEvalYFXPattern
  53 {
  54 public:
  55   virtual ~YACSEvalYFXPattern();
  56   std::vector< YACSEvalInputPort *> getFreeInputPorts() const;
  57   std::vector< YACSEvalOutputPort *> getFreeOutputPorts() const;
  58   static YACSEvalYFXPattern *FindPatternFrom(YACSEvalYFX *boss, YACS::ENGINE::Proc *scheme, bool ownScheme);
  59   void setParallelizeStatus(bool newVal) { _parallelizeStatus=newVal; }
  60   bool getParallelizeStatus() const { return _parallelizeStatus; }
  61   bool isAlreadyComputedResources() const;
  62   void checkNonAlreadyComputedResources() const;
  63   void checkAlreadyComputedResources() const;
  64   void checkLocked() const;
  65   void checkNonLocked() const;
  66   static void CheckNodeIsOK(YACS::ENGINE::ComposedNode *node);
  67   void registerObserver(YACSEvalObserver *observer);
  68   YACSEvalObserver *getObserver() const { return _observer; }
  69   YACSEvalYFX *getBoss() const { return _boss; }
  70   virtual void setOutPortsOfInterestForEvaluation(const std::vector<YACSEvalOutputPort *>& outputs) = 0;
  71   virtual void resetOutputsOfInterest() = 0;
  72   virtual void generateGraph() = 0;
  73   virtual void resetGeneratedGraph() = 0;
  74   virtual void assignRandomVarsInputs() = 0;
  75   virtual int assignNbOfBranches() = 0;
  76   virtual bool isLocked() const = 0;
  77   virtual YACSEvalListOfResources *giveResources() = 0;
  78   virtual YACS::ENGINE::Proc *getUndergroundGeneratedGraph() const = 0;
  79   virtual std::string getErrorDetailsInCaseOfFailure() const = 0;
  80   virtual std::string getStatusOfRunStr() const = 0;
  81   virtual std::vector<YACSEvalSeqAny *> getResults() const = 0;
  82   virtual std::vector<YACSEvalSeqAny *> getResultsInCaseOfFailure(std::vector<unsigned int>& passedIds) const = 0;
  83   virtual bool go(bool stopASAP, YACSEvalSession *session) const = 0;
  84 public:
  85   static const char DFT_PROC_NAME[];
  86 protected:
  87   YACSEvalYFXPattern(YACSEvalYFX *boss, YACS::ENGINE::Proc *scheme, bool ownScheme);
  88   YACS::ENGINE::TypeCode *createSeqTypeCodeFrom(YACS::ENGINE::Proc *scheme, const std::string& zeType);
  89   void setResources(YACSEvalListOfResources *res);
  90   void resetResources();
  91   YACSEvalListOfResources *getResourcesInternal() const { return _res; }
  92   ResourcesManager_cpp *getCatalogInAppli() const { return _rm; }
  93   static YACSEvalSeqAny *BuildValueInPort(YACS::ENGINE::InputPyPort *port);
  94   static YACSEvalSeqAny *BuildValueFromEngineFrmt(YACS::ENGINE::SequenceAny *data);
  95 private:
  96   void cleanScheme();
  97 private:
  98   YACSEvalYFX *_boss;
  99   bool _ownScheme;
 100   bool _parallelizeStatus;
 101   YACS::ENGINE::Proc *_scheme;
 102   ResourcesManager_cpp *_rm;
 103   YACSEvalListOfResources *_res;
 104   mutable YACSEvalObserver *_observer;
 105 protected:
 106   std::vector< YACSEvalInputPort > _inputs;
 107   std::vector< YACSEvalOutputPort > _outputs;
 108 public:
 109   static const char ST_OK[]; // execution goes to the end without any trouble -> results can be exploited without any problem with getResults and getResultsInCaseOfFailure.
 110   static const char ST_FAILED[]; // execution has reached some failed evaluation (normal errors due to incapacity of one node to evaluate) -> results can be exploited without any problem with getResultsInCaseOfFailure
 111   static const char ST_ERROR[]; // execution has encountered hard errors (SIGSEGV in a server, internal error in YACS) -> results can be exploited with getResultsInCaseOfFailure but you can't make hypothesis for other ids not in passedIds.
 112   static const std::size_t MAX_LGTH_OF_INP_DUMP;
 113 };
 114
 115 class YACSEvalYFXRunOnlyPattern : public YACSEvalYFXPattern
 116 {
 117 public:
 118   YACSEvalYFXRunOnlyPattern(YACSEvalYFX *boss, YACS::ENGINE::Proc *scheme, bool ownScheme, YACS::ENGINE::ComposedNode *runNode);
 119   ~YACSEvalYFXRunOnlyPattern();
 120   void setOutPortsOfInterestForEvaluation(const std::vector<YACSEvalOutputPort *>& outputsOfInterest);
 121   void resetOutputsOfInterest();
 122   void generateGraph();
 123   void resetGeneratedGraph();
 124   int assignNbOfBranches();
 125   void assignRandomVarsInputs();
 126   bool isLocked() const;
 127   YACSEvalListOfResources *giveResources();
 128   YACS::ENGINE::Proc *getUndergroundGeneratedGraph() const;
 129   std::string getErrorDetailsInCaseOfFailure() const;
 130   std::string getStatusOfRunStr() const;
 131   std::vector<YACSEvalSeqAny *> getResults() const;
 132   std::vector<YACSEvalSeqAny *> getResultsInCaseOfFailure(std::vector<unsigned int>& passedIds) const;
 133   bool go(bool stopASAP, YACSEvalSession *session) const;
 134   //
 135   YACS::ENGINE::ForEachLoop *getUndergroundForEach() const { return _FEInGeneratedGraph; }
 136   static bool IsMatching(YACS::ENGINE::Proc *scheme, YACS::ENGINE::ComposedNode *& runNode);
 137 public:
 138   static const char FIRST_FE_SUBNODE_NAME[];
 139   static const char GATHER_NODE_NAME[];
 140 private:
 141   void emitStart() const;
 142   void buildInputPorts();
 143   void buildOutputPorts();
 144   YACS::ENGINE::ForEachLoop *findTopForEach() const;
 145 private:
 146   YACS::ENGINE::ComposedNode *_runNode;
 147   std::vector<YACSEvalOutputPort *> _outputsOfInterest;
 148   YACS::ENGINE::Proc *_generatedGraph;
 149   YACS::ENGINE::ForEachLoop *_FEInGeneratedGraph;
 150   YACSEvalYFXRunOnlyPatternInternalObserver *_obs;
 151 };
 152
 153 #endif