src/engine/WhileLoop.hxx

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