ForLoop.cxx

Go to the documentation of this file.

// Copyright (C) 2006-2025  CEA, EDF
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
 
#include "ForLoop.hxx"
#include "Runtime.hxx"
#include "LinkInfo.hxx"
#include "OutputPort.hxx"
#include "Visitor.hxx"
#include <iostream>
 
//#define _DEVDEBUG_
#include "YacsTrace.hxx"
 
using namespace YACS::ENGINE;
using namespace std;
 
const char ForLoop::NAME_OF_NSTEPS_NUMBER[]="nsteps";
const char ForLoop::NAME_OF_INDEX[]="index";
 
ForLoop::ForLoop(const std::string& name):Loop(name),_nbOfTimesPort(NAME_OF_NSTEPS_NUMBER,this,Runtime::_tc_int),
                                                     _indexPort(NAME_OF_INDEX,this,Runtime::_tc_int)
{
}
 
ForLoop::ForLoop(const ForLoop& other, ComposedNode *father, bool editionOnly):Loop(other,father,editionOnly),
                                                                               _nbOfTimesPort(other._nbOfTimesPort,this),
                                                                               _indexPort(other._indexPort,this)
{
  //Copy Data linking
  std::vector< std::pair<OutPort *, InPort *> > linksToReproduce=other.getSetOfInternalLinks();
  std::vector< std::pair<OutPort *, InPort *> >::iterator iter=linksToReproduce.begin();
  for(;iter!=linksToReproduce.end();++iter)
    {
      OutPort* pout = iter->first;
      InPort* pin = iter->second;
      edAddLink(getOutPort(other.getPortName(pout)),getInPort(other.getPortName(pin)));
    }
}
 
Node *ForLoop::simpleClone(ComposedNode *father, bool editionOnly) const
{
  return new ForLoop(*this,father,editionOnly);
}
 
InputPort* ForLoop::getInputPort(const std::string& name) const
{
    if(name == NAME_OF_NSTEPS_NUMBER)return (InputPort*)&_nbOfTimesPort;
    return Loop::getInputPort(name);
 
}
 
 
void ForLoop::init(bool start)
{
  DEBTRACE("ForLoop::init " << start);
  Loop::init(start);
  _nbOfTimesPort.exInit(start);
  _indexPort.exInit();
  Any* tmp=AtomAny::New(_nbOfTurns);
  _indexPort.put(tmp);
  tmp->decrRef();
  exUpdateProgress();
}
 
 
void ForLoop::exUpdateState()
{
  DEBTRACE("ForLoop::exUpdateState " << getName() << " " << _state);
  if(_state == YACS::DISABLED)
    return;
  if(_inGate.exIsReady())
    {
      setState(YACS::ACTIVATED);
      _node->exUpdateState();
      if(_nbOfTimesPort.isEmpty())
        {
          delete _nodeForNullTurnOfLoops;
          _nodeForNullTurnOfLoops=new FakeNodeForLoop(this,false,true);
        }
      else
        {
          if(_nbOfTimesPort.getIntValue()==0)
            {
              bool normalFinish=getAllOutPortsLeavingCurrentScope().empty();
              delete _nodeForNullTurnOfLoops;
              _nodeForNullTurnOfLoops=new FakeNodeForLoop(this,normalFinish);
            }
          else if(_nbOfTimesPort.getIntValue()<0)
            {
              delete _nodeForNullTurnOfLoops;
              _nodeForNullTurnOfLoops=new FakeNodeForLoop(this,false);
            }
          else
            {
              delete _nodeForNullTurnOfLoops;
              _nodeForNullTurnOfLoops=0;
            }
        }
    }
}
 
 
YACS::Event ForLoop::updateStateOnFinishedEventFrom(Node *node)
{
  DEBTRACE("ForLoop::updateStateOnFinishedEventFrom " << node->getName());
  exUpdateProgress();
  if((++_nbOfTurns)>=_nbOfTimesPort.getIntValue())
    {
      setState(YACS::DONE);
      return YACS::FINISH;
    }
  else
    {
      Any* tmp=AtomAny::New(_nbOfTurns);
      _indexPort.put(tmp);
      tmp->decrRef();
      setState(YACS::ACTIVATED);
      _node->init(false);
      _node->exUpdateState();
    }
  return YACS::NOEVENT;
}
 
void ForLoop::exUpdateProgress()
{
  // emit notification to all observers registered with the dispatcher on any change of the node's state
  sendEvent("progress");
}
 
void ForLoop::accept(Visitor *visitor)
{
  visitor->visitForLoop(this);
}
 
std::list<InputPort *> ForLoop::getLocalInputPorts() const
{
  list<InputPort *> ret;
  ret.push_back((InputPort *)&_nbOfTimesPort);
  return ret;
}
 
OutPort *ForLoop::getOutPort(const std::string& name) const
{
  if(name==NAME_OF_INDEX)
    return (OutPort *)&_indexPort;
  return Loop::getOutPort(name);
}
 
OutputPort *ForLoop::getOutputPort(const std::string& name) const
{
  if(name==NAME_OF_INDEX)
    return (OutputPort *)&_indexPort;
  return Loop::getOutputPort(name);
}
 
std::list<OutputPort *> ForLoop::getLocalOutputPorts() const
{
  list<OutputPort *> ret;
  ret.push_back(getOutputPort(NAME_OF_INDEX)); 
  return ret;
}
 
void ForLoop::checkControlDependancy(OutPort *start, InPort *end, bool cross,
                                     std::map < ComposedNode *,  std::list < OutPort * >, SortHierarc >& fw,
                                     std::vector<OutPort *>& fwCross,
                                     std::map< ComposedNode *, std::list < OutPort *>, SortHierarc >& bw,
                                     LinkInfo& info) const
{
  //First testing if start==indexPort. This is the only case possible in theory.
  if(start != &_indexPort)
    return StaticDefinedComposedNode::checkControlDependancy(start,end,cross,fw,fwCross,bw,info);
  if(cross)
    throw Exception("Internal error occured - cross type link detected on decision port of a loop. Forbidden !");
  fw[(ComposedNode *)this].push_back(start);
}
 
void ForLoop::checkCFLinks(const std::list<OutPort *>& starts, InputPort *end, unsigned char& alreadyFed, 
                           bool direction, LinkInfo& info) const
{
  const char what[]="ForLoop::checkCFLinks : internal error.";
  Node *nodeEnd=end->getNode();
  if(nodeEnd==this)
    {//In this case 'end' port is a special port of this (for exemple ForLoop::_nbOfTimesPort)
      solveObviousOrDelegateCFLinks(starts,end,alreadyFed,direction,info);
    }
  else if(isInMyDescendance(nodeEnd)==0)
    {
      solveObviousOrDelegateCFLinks(starts,end,alreadyFed,direction,info);
    }
  else
    {//no forwarding here.
      if(starts.size()!=1)
        throw Exception(what);
 
      Node *nodeStart=(*(starts.begin()))->getNode();
      if(nodeStart==this)
        {
          // Link between the loop and the internal node
          if(*(starts.begin())!=&_indexPort)
            throw Exception(what);
        }
      else
        {
          // Link from internal node to internal node
          if(nodeEnd!=nodeStart)
            throw Exception(what);
        }
 
      if(alreadyFed==FREE_ST)
        alreadyFed=FED_ST;
      else if(alreadyFed==FED_ST)
        {
          info.pushInfoLink(*(starts.begin()),end,I_USELESS);
        }
    }
}
 
std::list<OutputPort *> ForLoop::getSetOfOutputPort() const
{
  list<OutputPort *> ret=ComposedNode::getSetOfOutputPort();
  ret.push_back((OutputPort *)&_indexPort);
  return ret;
}
 
 
int ForLoop::getNbSteps() const
{
  AnyInputPort* aNbStepsPort = (AnyInputPort*)&_nbOfTimesPort;
  int nbSteps = 0;
  if (aNbStepsPort && !aNbStepsPort->isEmpty())
    nbSteps = aNbStepsPort->getIntValue();
  return nbSteps;
}
 
std::string ForLoop::getProgress() const
{
  std::stringstream aProgress;
  aProgress << "0";
  int nbSteps = getNbSteps();
  if (nbSteps > 0 && _nbOfTurns >= 0)
    {
      aProgress.str("");
      aProgress << _nbOfTurns << "/" << nbSteps;
    }
  return aProgress.str();
}
 
 
list<ProgressWeight> ForLoop::getProgressWeight() const
{
  list<ProgressWeight> ret;
  list<Node *> setOfNode=edGetDirectDescendants();
  int nbStepsDone=getNbOfTurns();
  int nbStepsTotal=getNbSteps();
  for(list<Node *>::const_iterator iter=setOfNode.begin();iter!=setOfNode.end();iter++)
    {
      list<ProgressWeight> myCurrentSet=(*iter)->getProgressWeight();
        for(list<ProgressWeight>::iterator iter=myCurrentSet.begin();iter!=myCurrentSet.end();iter++)
          {
            (*iter).weightDone=((*iter).weightTotal) * nbStepsDone;
            (*iter).weightTotal*=nbStepsTotal;
          }
        ret.insert(ret.end(),myCurrentSet.begin(),myCurrentSet.end());
    }
  return ret;
}