src/engine/WhileLoop.hxx

   1 // Copyright (C) 2006-2014  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 __WHILELOOP_HXX__
  21 #define __WHILELOOP_HXX__
  22
  23 #include "YACSlibEngineExport.hxx"
  24 #include "Loop.hxx"
  25 #include "ConditionInputPort.hxx"
  26
  27 namespace YACS
  28 {
  29   namespace ENGINE
  30   {
  31 /*! \brief Class for a while loop
  32  *
  33  * \ingroup Nodes
  34  *
  35  *  This node makes steps while the condition is true
  36  *
  37  */
  38     class YACSLIBENGINE_EXPORT WhileLoop : public Loop
  39     {
  40     protected:
  41       static const char NAME_OF_INPUT_CONDITION[];
  42       ConditionInputPort _conditionPort;
  43     public:
  44       WhileLoop(const WhileLoop& other, ComposedNode *father, bool editionOnly);
  45       WhileLoop(const std::string& name);
  46       void exUpdateState();
  47       void init(bool start=true);
  48       InputPort *edGetConditionPort() { return &_conditionPort; }
  49       InputPort* getInputPort(const std::string& name) const throw(Exception);
  50       std::list<InputPort *> getLocalInputPorts() const;
  51       virtual void accept(Visitor *visitor);
  52       InputPort *getDecisionPort() const { return (InputPort *)&_conditionPort; }
  53       virtual std::string typeName() {return "YACS__ENGINE__WhileLoop";}
  54     protected:
  55       Node *simpleClone(ComposedNode *father, bool editionOnly=true) const;
  56       void checkLinkPossibility(OutPort *start, const std::list<ComposedNode *>& pointsOfViewStart,
  57                                 InPort *end, const std::list<ComposedNode *>& pointsOfViewEnd) throw(Exception);
  58       YACS::Event updateStateOnFinishedEventFrom(Node *node);
  59     };
  60   }
  61 }
  62
  63 #endif