Base class for loop node. More...

#include <Loop.hxx>

Inheritance diagram for YACS::ENGINE::Loop:

Collaboration diagram for YACS::ENGINE::Loop:

Public Member Functions
	Loop (const Loop &other, ComposedNode *father, bool editionOnly)

	Loop (const std::string &name)

	~Loop ()

void	init (bool start=true)

int	getNbOfTurns () const

Node *	edSetNode (Node *DISOWNnode)

virtual bool	edAddChild (Node *DISOWNnode) throw (Exception)

Node *	edRemoveNode ()

virtual void	checkBasicConsistency () const throw (Exception)

virtual InputPort *	getDecisionPort () const =0
	Returns the port which value is used to take decision about the continuation of the loop. More...

void	getReadyTasks (std::vector< Task * > &tasks)
	Collect all the child nodes that are ready. More...

void	edRemoveChild (Node *node) throw (Exception)
	Remove a child node. More...

bool	isRepeatedUnpredictablySeveralTimes () const

std::list< Node * >	edGetDirectDescendants () const

std::list< InputPort * >	getSetOfInputPort () const

int	getNumberOfInputPorts () const

int	getMaxLevelOfParallelism () const

Node *	getChildByShortName (const std::string &name) const throw (Exception)

virtual bool	edAddDFLink (OutPort start, InPort end) throw (Exception)
	Connect an OutPort to an InPort and add control link if necessary. More...

void	writeDot (std::ostream &os) const
	Dump the node state to a stream. More...

virtual void	accept (Visitor *visitor)

virtual std::string	typeName ()

Public Member Functions inherited from YACS::ENGINE::StaticDefinedComposedNode
bool	isPlacementPredictableB4Run () const

bool	isMultiplicitySpecified (unsigned &value) const

void	forceMultiplicity (unsigned value)

void	selectRunnableTasks (std::vector< Task * > &tasks)

Public Member Functions inherited from YACS::ENGINE::ComposedNode
virtual	~ComposedNode ()

bool	isFinished ()

virtual void	shutdown (int level)
	Stop all pending activities of the composed node. More...

virtual void	resetState (int level)
	Reset the state of the node and its children depending on the parameter level. More...

std::string	getName () const

std::string	getTaskName (Task *task) const

DeploymentTree	getDeploymentTree () const
	Essentially for test. Use checkDeploymentTree instead to be sure that returned DeploymentTree is consistent. More...

DeploymentTree	checkDeploymentTree (bool deep) const throw (Exception)
	Perform check of deployment consistency of the current graph. More...

std::vector< Task * >	getNextTasks (bool &isMore)

void	notifyFrom (const Task sender, YACS::Event event, const Executor execInst)
	Notify the node a task has emitted an event. More...

bool	edAddLink (OutPort start, InPort end) throw (Exception)
	Add a dataflow link between two data ports. More...

bool	edAddLink (OutGate start, InGate end) throw (Exception)
	Add a controlflow link between two control ports. More...

bool	edAddCFLink (Node nodeS, Node nodeE) throw (Exception)
	Add a controlflow link between two nodes. More...

void	edRemoveCFLink (Node nodeS, Node nodeE) throw (Exception)
	Remove a controlflow link. More...

void	edRemoveLink (OutPort start, InPort end) throw (Exception)
	Remove a dataflow link. More...

void	edRemoveLink (OutGate start, InGate end) throw (Exception)
	Remove a controlflow link. More...

virtual void	removeRecursivelyRedundantCL ()

std::list< ElementaryNode * >	getRecursiveConstituents () const

std::list< Node * >	getAllRecursiveNodes ()
	Get all children nodes elementary and composed including this node. More...

virtual std::list< Node * >	getAllRecursiveConstituents ()
	Idem getAllRecursiveNodes, but this node is NOT included. More...

std::list< ProgressWeight >	getProgressWeight () const
	Get the progress weight for all elementary nodes. More...

std::string	getInPortName (const InPort *) const throw (Exception)
	Get the input port name. More...

std::string	getOutPortName (const OutPort *) const throw (Exception)

int	getNumberOfOutputPorts () const

std::list< OutputPort * >	getSetOfOutputPort () const

std::list< InputPort * >	getLocalInputPorts () const
	redefined on derived class of ComposedNode. by default a ComposedNode has no port by itself More...

std::list< OutputPort * >	getLocalOutputPorts () const
	redefined on derived class of ComposedNode. by default a ComposedNode has no port by itself More...

std::set< OutPort * >	getAllOutPortsLeavingCurrentScope () const
	List all output ports of children nodes that are linked to out of scope input ports. More...

std::set< InPort * >	getAllInPortsComingFromOutsideOfCurrentScope () const
	List all input ports that are linked to out of scope ports. More...

std::list< InputDataStreamPort * >	getSetOfInputDataStreamPort () const

std::list< OutputDataStreamPort * >	getSetOfOutputDataStreamPort () const

OutPort *	getOutPort (const std::string &name) const throw (Exception)

InputPort *	getInputPort (const std::string &name) const throw (Exception)
	Get an input port given its name. More...

OutputPort *	getOutputPort (const std::string &name) const throw (Exception)
	Get an output port given its name. More...

InputDataStreamPort *	getInputDataStreamPort (const std::string &name) const throw (Exception)

OutputDataStreamPort *	getOutputDataStreamPort (const std::string &name) const throw (Exception)

std::vector< std::pair < OutPort , InPort > >	getSetOfInternalLinks () const

virtual std::vector< std::pair < OutPort , InPort > >	getSetOfLinksLeavingCurrentScope () const

void	checkConsistency (LinkInfo &info) const throw (Exception)

virtual std::vector< std::pair < InPort , OutPort > >	getSetOfLinksComingInCurrentScope () const

virtual void	edUpdateState ()
	update the status of the node More...

virtual std::string	getErrorReport ()
	returns a string that contains an error report if the node is in error More...

ComposedNode *	getRootNode () const throw (Exception)

bool	isNodeAlreadyAggregated (const Node *node) const
	Check that Node 'node' is already a direct son of this. More...

virtual bool	isNameAlreadyUsed (const std::string &name) const

Node *	isInMyDescendance (Node *nodeToTest) const
	Returns the parent of a node that is the direct child of this node. More...

std::string	getChildName (const Node *node) const throw (Exception)

virtual std::string	getMyQualifiedName (const Node *directSon) const

Node *	getChildByName (const std::string &name) const throw (Exception)

void	loaded ()

void	connected ()

virtual void	cleanNodes ()
	Clean the composed node in case of not clean exit. More...

virtual std::string	getProgress () const

Public Member Functions inherited from YACS::ENGINE::Node
virtual	~Node ()

Node *	clone (ComposedNode *father, bool editionOnly=true) const
	This method MUST NEVER BE VIRTUAL More...

Node *	cloneWithoutCompAndContDeepCpy (ComposedNode *father, bool editionOnly=true) const
	This method MUST NEVER BE VIRTUAL More...

void	setState (YACS::StatesForNode theState)
	Sets the given state for node. More...

virtual YACS::StatesForNode	getState () const

virtual YACS::StatesForNode	getEffectiveState () const
	Return the node state in the context of its father. More...

virtual YACS::StatesForNode	getEffectiveState (const Node *) const
	Return the effective state of a node in the context of this one (its father) More...

std::string	getColorState (YACS::StatesForNode state) const
	Return the color associated to a state. More...

InGate *	getInGate ()

OutGate *	getOutGate ()

const std::string &	getName () const

void	setName (const std::string &name)
	Change the name of the node. More...

ComposedNode *	getFather () const

const std::string	getId () const

bool	exIsControlReady () const

std::list< Node * >	getOutNodes () const

virtual void	exUpdateState ()
	Update the node state. More...

virtual void	exFailedState ()
	Notify this node that its execution has failed. More...

virtual void	exDisabledState ()
	Notify this node that it has been disabled. More...

std::list< InPort * >	getSetOfInPort () const

std::list< OutPort * >	getSetOfOutPort () const

virtual std::set< InputPort * >	edGetSetOfUnitializedInputPort () const
	Becomes deprecated soon. Replaced by ComposedNode::CheckConsistency. More...

virtual bool	edAreAllInputPortInitialized () const
	Becomes deprecated soon. Replaced by ComposedNode::CheckConsistency. More...

InPort *	getInPort (const std::string &name) const throw (Exception)

InPropertyPort *	getInPropertyPort () const throw (Exception)

std::list< ComposedNode * >	getAllAscendanceOf (ComposedNode *levelToStop=0) const

bool	operator> (const Node &other) const

bool	operator< (const Node &other) const

std::string	getImplementation () const

virtual void	setProperty (const std::string &name, const std::string &value)

virtual std::string	getProperty (const std::string &name)

std::map< std::string, std::string >	getProperties ()

std::map< std::string, std::string >	getPropertyMap ()

virtual void	setProperties (std::map< std::string, std::string > properties)

virtual Proc *	getProc ()

virtual const Proc *	getProc () const

std::string	getQualifiedName () const
	same as Node::getName() in most cases, but differs for children of switch More...

int	getNumId ()
	return node instance identifiant, unique for each node instance More...

std::vector< std::pair < std::string, int > >	getDPLScopeInfo (ComposedNode *gfn)

virtual void	applyDPLScope (ComposedNode *gfn)

virtual void	sendEvent (const std::string &event)
	emit notification to all observers registered with the dispatcher More...

virtual void	sendEvent2 (const std::string &event, void *something)
	emit notification to all observers registered with the dispatcher More...

virtual std::string	getErrorDetails () const

virtual void	setErrorDetails (const std::string &error)

virtual void	modified ()
	Sets Node in modified state and its father if it exists. More...

virtual int	isModified ()

virtual int	isValid ()
	indicates if the node is valid (returns 1) or not (returns 0) More...

virtual std::string	getContainerLog ()
	returns a string that contains the name of the container log file if it exists More...

virtual void	ensureLoading ()
	Put this node into TOLOAD state when possible. More...

virtual void	getCoupledNodes (std::set< Task * > &coupledNodes)

Public Member Functions inherited from YACS::ENGINE::Scheduler
virtual void	exUpdateState ()=0

virtual	~Scheduler ()

Static Public Member Functions
static TypeCode *	MappingDF2DS (TypeCode *type) throw (Exception)

static TypeCode *	MappingDS2DF (TypeCode *type) throw (Exception)

Protected Member Functions
void	buildDelegateOf (InPort &port, OutPort initialStart, const std::list< ComposedNode * > &pointsOfView)

void	buildDelegateOf (std::pair< OutPort , OutPort > &port, InPort finalTarget, const std::list< ComposedNode > &pointsOfView)

void	getDelegateOf (InPort &port, OutPort initialStart, const std::list< ComposedNode * > &pointsOfView) throw (Exception)

void	getDelegateOf (std::pair< OutPort , OutPort > &port, InPort finalTarget, const std::list< ComposedNode > &pointsOfView) throw (Exception)

void	releaseDelegateOf (InPort &port, OutPort initialStart, const std::list< ComposedNode * > &pointsOfView) throw (Exception)

void	releaseDelegateOf (OutPort portDwn, OutPort portUp, InPort finalTarget, const std::list< ComposedNode > &pointsOfView) throw (Exception)

void	checkNoCyclePassingThrough (Node *node) throw (Exception)

void	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

void	checkCFLinks (const std::list< OutPort * > &starts, InputPort *end, unsigned char &alreadyFed, bool direction, LinkInfo &info) const
	check control flow links More...

Protected Member Functions inherited from YACS::ENGINE::StaticDefinedComposedNode
	StaticDefinedComposedNode (const std::string &name)

	StaticDefinedComposedNode (const StaticDefinedComposedNode &other, ComposedNode *father)

void	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

Protected Member Functions inherited from YACS::ENGINE::ComposedNode
	ComposedNode (const std::string &name)

	ComposedNode (const ComposedNode &other, ComposedNode *father)

void	performDuplicationOfPlacement (const Node &other)
	performs a duplication of placement using clone method of containers and components. clone behaviour is driven by attachOnCloning attribute. More...

void	performShallowDuplicationOfPlacement (const Node &other)
	performs a also duplication of placement but here containers and components are not copied at all whatever the value of attachedOnCloning. More...

void	edDisconnectAllLinksWithMe ()

YACS::Event	updateStateFrom (Node node, YACS::Event event, const Executor execInst)
	Update node state on receiving event from a node. More...

virtual YACS::Event	updateStateOnStartEventFrom (Node *node)
	Method used to notify the node that a child node has started. More...

virtual YACS::Event	updateStateOnFinishedEventFrom (Node *node)=0

virtual YACS::Event	updateStateOnFailedEventFrom (Node node, const Executor execInst)
	Method used to notify the node that a child node has failed. More...

virtual void	checkLinkPossibility (OutPort start, const std::list< ComposedNode > &pointsOfViewStart, InPort end, const std::list< ComposedNode > &pointsOfViewEnd) throw (Exception)

void	checkInMyDescendance (Node *nodeToTest) const throw (Exception)
	Check if a node is in the descendance of this node. More...

template<class PORT >
std::string	getPortName (const PORT *port) const throw (Exception)

void	checkNoCrossHierachyWith (Node *node) const throw (Exception)

virtual void	performCFComputations (LinkInfo &info) const
	perform recursively all CF computations. More...

virtual void	destructCFComputations (LinkInfo &info) const
	destroy recursively all results of initial computations. More...

Node *	getLowestNodeDealingAll (const std::list< OutPort * > &ports) const

void	checkLinksCoherenceRegardingControl (const std::vector< OutPort * > &starts, InputPort *end, LinkInfo &info) const throw (Exception)

void	solveObviousOrDelegateCFLinks (const std::list< OutPort * > &starts, InputPort *end, unsigned char &alreadyFed, bool direction, LinkInfo &info) const

Protected Member Functions inherited from YACS::ENGINE::Node
	Node (const std::string &name)

	Node (const Node &other, ComposedNode *father)

virtual Node *	simpleClone (ComposedNode *father, bool editionOnly=true) const =0

virtual void	exForwardFailed ()

virtual void	exForwardFinished ()

Static Protected Member Functions
static bool	isNecessaryToBuildSpecificDelegateDF2DS (const std::list< ComposedNode * > &pointsOfView)

Protected Attributes
Node *	_node

int	_nbOfTurns

FakeNodeForLoop *	_nodeForNullTurnOfLoops

std::set< DSToDFForLoop * >	_inputsTraducer

std::set< DFToDSForLoop * >	_outputsTraducer

Friends
class	DSToDFForLoop

class	FakeNodeForLoop

void	NbDoneLoader (Loop *node, int val)

Additional Inherited Members
Public Attributes inherited from YACS::ENGINE::Node
YACS::Colour	_colour

Static Public Attributes inherited from YACS::ENGINE::Node
static std::map< int, Node * >	idMap

Static Protected Attributes inherited from YACS::ENGINE::ComposedNode
static const char	SEP_CHAR_BTW_LEVEL [] ="."

static const unsigned char	FED_ST = 2

static const unsigned char	FREE_ST = 0

static const unsigned char	FED_DS_ST = 1

Detailed Description

Base class for loop node.

See Also: ForLoop; WhileLoop

Definition at line 145 of file Loop.hxx.

Constructor & Destructor Documentation

Loop::Loop	(	const Loop &	other,
		ComposedNode *	father,
		bool	editionOnly
	)

Definition at line 293 of file Loop.cxx.

References _node, and YACS::ENGINE::Node::simpleClone().

                                                                    :StaticDefinedComposedNode(other,father),_nbOfTurns(0),_nodeForNullTurnOfLoops(0),_node(0)
 {
   if(other._node)
     _node=other._node->simpleClone(this,editionOnly);
 }

Loop::Loop ( const std::string & name )

Definition at line 299 of file Loop.cxx.

                                :StaticDefinedComposedNode(name),_node(0),_nbOfTurns(0),_nodeForNullTurnOfLoops(0)
 {
 }

Loop::~Loop ( )

Definition at line 303 of file Loop.cxx.

References _inputsTraducer, _node, _nodeForNullTurnOfLoops, and _outputsTraducer.

 {
   delete _node;
   if(_nodeForNullTurnOfLoops)delete _nodeForNullTurnOfLoops;
   for(set<DSToDFForLoop *>::iterator iter1=_inputsTraducer.begin();iter1!=_inputsTraducer.end();iter1++)
     delete (*iter1);
   for(set<DFToDSForLoop *>::iterator iter2=_outputsTraducer.begin();iter2!=_outputsTraducer.end();iter2++)
     delete (*iter2);
 }

Member Function Documentation

void Loop::accept ( Visitor * visitor )

virtual

Reimplemented from YACS::ENGINE::ComposedNode.

Reimplemented in YACS::ENGINE::ForLoop, and YACS::ENGINE::WhileLoop.

Definition at line 656 of file Loop.cxx.

References YACS::ENGINE::Visitor::visitLoop().

 {
   visitor->visitLoop(this);
 }

void Loop::buildDelegateOf	(	InPort *&	port,
		OutPort *	initialStart,
		const std::list< ComposedNode * > &	pointsOfView
	)

protectedvirtual

Reimplemented from YACS::ENGINE::ComposedNode.

Definition at line 441 of file Loop.cxx.

References _inputsTraducer, DSToDFForLoop, YACS::ENGINE::DataPort::edGetType(), YACS::ENGINE::DataPort::getName(), YACS::ENGINE::DataPort::getNameOfTypeOfCurrentInstance(), isNecessaryToBuildSpecificDelegateDF2DS(), MappingDF2DS(), YACS::ENGINE::InputPort::NAME, and YACS::ENGINE::OutputPort::NAME.

 {
   string typeOfPortInstance=port->getNameOfTypeOfCurrentInstance();
   if(typeOfPortInstance!=InputPort::NAME ||
      (typeOfPortInstance == InputPort::NAME && 
       initialStart->getNameOfTypeOfCurrentInstance()== OutputPort::NAME && 
       !isNecessaryToBuildSpecificDelegateDF2DS(pointsOfView)) )
     return ;
   InputPort *portCasted=(InputPort *)port;
   set<DSToDFForLoop*>::iterator iter;
   //Determinig if a DSToDFForLoop node has already been created for delegation of 'port'
   for(iter=_inputsTraducer.begin();iter!=_inputsTraducer.end();iter++)
     if((*iter)->getOutputPort("")->isAlreadyInSet(portCasted))
       break;
   if(iter==_inputsTraducer.end())
     {//first time that 'port' is delegated on higher level
       pair<set<DSToDFForLoop*>::iterator, bool> iter2=_inputsTraducer.insert(new DSToDFForLoop(this,portCasted->getName(),Loop::MappingDF2DS(portCasted->edGetType())));
       iter=iter2.first;
       (*iter)->getOutputPort("")->addInPort(portCasted);
     }
   else
     (*iter)->loopHasOneMoreRef();
   port=(*iter)->getInputDataStreamPort("");
 }

void Loop::buildDelegateOf	(	std::pair< OutPort , OutPort > &	port,
		InPort *	finalTarget,
		const std::list< ComposedNode * > &	pointsOfView
	)

protectedvirtual

Reimplemented from YACS::ENGINE::ComposedNode.

Definition at line 466 of file Loop.cxx.

References _outputsTraducer, YACS::ENGINE::OutPort::addInPort(), YACS::ENGINE::ComposedNode::edAddLink(), YACS::ENGINE::DataPort::edGetType(), YACS::ENGINE::Node::getInGate(), YACS::ENGINE::DataPort::getName(), YACS::ENGINE::DataPort::getNameOfTypeOfCurrentInstance(), YACS::ENGINE::Node::getOutGate(), YACS::ENGINE::OutPort::isAlreadyLinkedWith(), YACS::ENGINE::ComposedNode::isInMyDescendance(), isNecessaryToBuildSpecificDelegateDF2DS(), YACS::ENGINE::DFToDSForLoop::loopHasOneMoreRef(), YACS::ENGINE::InputPort::NAME, and YACS::ENGINE::OutputPort::NAME.

 {
   string typeOfPortInstance=(port.first)->getNameOfTypeOfCurrentInstance();
   if(typeOfPortInstance!=OutputPort::NAME ||
     ( typeOfPortInstance == OutputPort::NAME && 
       finalTarget->getNameOfTypeOfCurrentInstance()== InputPort::NAME && 
       !isNecessaryToBuildSpecificDelegateDF2DS(pointsOfView)) )
     return ;
   OutPort *portCasted=port.first;
   set<DFToDSForLoop*>::iterator iter;
   //Determinig if a DFToDSForLoop node has already been created for delegation of 'port'
   for(iter=_outputsTraducer.begin();iter!=_outputsTraducer.end();iter++)
     if(portCasted->isAlreadyLinkedWith((*iter)->getInputPort("")))
       break;
   DFToDSForLoop *kl;
   if(iter==_outputsTraducer.end())
     {//first time that 'port' is delegated on higher level
       //_outputsTraducer.insert(new DFToDSForLoop(this,portCasted->getName(),portCasted->edGetType()));
       kl=new DFToDSForLoop(this,portCasted->getName(),portCasted->edGetType());
       pair<set<DFToDSForLoop*>::iterator, bool> iter2=_outputsTraducer.insert(kl);
       iter=iter2.first;
       portCasted->addInPort((*iter)->getInputPort(""));
     }
   else
     {
       kl=*iter;
       kl->loopHasOneMoreRef();
     }
   edAddLink(isInMyDescendance((port.first)->getNode())->getOutGate(),kl->getInGate());
   port.first=(*iter)->getOutputDataStreamPort("");
 }

void Loop::checkBasicConsistency ( ) const throw (Exception)

virtual

Reimplemented from YACS::ENGINE::ComposedNode.

Definition at line 675 of file Loop.cxx.

References _node, YACS::ENGINE::ComposedNode::checkBasicConsistency(), and DEBTRACE.

 {
   DEBTRACE("Loop::checkBasicConsistency");
   ComposedNode::checkBasicConsistency();
   if(!_node)
     throw Exception("For a loop, internal node is mandatory");
 }

void Loop::checkCFLinks	(	const std::list< OutPort * > &	starts,
		InputPort *	end,
		unsigned char &	alreadyFed,
		bool	direction,
		LinkInfo &	info
	)		const

protectedvirtual

check control flow links

Parameters

starts	If different of 0, must aggregate at leat 1 element.
end	:
alreadyFed	in/out parameter. Indicates if 'end' ports is already and surely set or fed by an another port.
direction	If true : forward direction else backward direction.
info	: informations collectedduring the check

Reimplemented from YACS::ENGINE::ComposedNode.

Definition at line 594 of file Loop.cxx.

References YACS::ENGINE::ComposedNode::checkCFLinks(), YACS::ENGINE::Port::getNode(), and YACS::ENGINE::ComposedNode::solveObviousOrDelegateCFLinks().

 {
   Node *nodeEnd=end->getNode();
   if(nodeEnd==this)
     {//In this case 'end' port is a special port of this (for exemple ForLoop::_nbOfTimesPort)
       //ASSERT(!direction) see Loop::checkControlDependancy (bw only)
       solveObviousOrDelegateCFLinks(starts,end,alreadyFed,direction,info);
     }
   else
     StaticDefinedComposedNode::checkCFLinks(starts,end,alreadyFed,direction,info);
 }

void Loop::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

protectedvirtual

Implements YACS::ENGINE::ComposedNode.

Definition at line 661 of file Loop.cxx.

References YACS::ENGINE::StaticDefinedComposedNode::checkControlDependancy(), and getDecisionPort().

 {
   //First testing if end==getDecisionPort. This is the only case possible in theory.
   if(end!=getDecisionPort())
     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 Loop::checkNoCyclePassingThrough ( Node * node ) throw (Exception)

protectedvirtual

Implements YACS::ENGINE::ComposedNode.

Definition at line 589 of file Loop.cxx.

 {
   //throw Exception("Loop::checkNoCyclePassingThrough : Internal error occured");
 }

bool Loop::edAddChild ( Node * DISOWNnode ) throw (Exception)

virtual

Reimplemented from YACS::ENGINE::ComposedNode.

Definition at line 347 of file Loop.cxx.

 {
   return edSetNode(node);
 }

bool Loop::edAddDFLink	(	OutPort *	start,
		InPort *	end
	)		throw (Exception)

virtual

Connect an OutPort to an InPort and add control link if necessary.

Connect the ports with a data link (edAddLink) In a Loop don't add control flow link : use this only to add data back links

Parameters

start	: the OutPort to connect
end	: the InPort to connect

Returns: true if a new link has been created, false otherwise.

Reimplemented from YACS::ENGINE::ComposedNode.

Definition at line 629 of file Loop.cxx.

 {
   return edAddLink(start,end);
 }

std::list< Node * > Loop::edGetDirectDescendants ( ) const

virtual

Implements YACS::ENGINE::ComposedNode.

Definition at line 395 of file Loop.cxx.

References _node, and PMMLBasicsTestLauncher::ret.

Referenced by YACS::ENGINE::ForLoop::getProgressWeight().

 {
   list<Node *> ret;
   if(_node)
     ret.push_back(_node);
   return ret;
 }

void Loop::edRemoveChild ( Node * node ) throw (Exception)

virtual

Remove a child node.

Reimplemented from YACS::ENGINE::ComposedNode.

Definition at line 387 of file Loop.cxx.

References YACS::ENGINE::ComposedNode::edRemoveChild().

 {
   StaticDefinedComposedNode::edRemoveChild(node);
   if(_node==node)
     _node=0;
   modified();
 }

Node * Loop::edRemoveNode ( )

Definition at line 352 of file Loop.cxx.

References _node, YACS::ENGINE::ComposedNode::edRemoveChild(), YACS::ENGINE::Node::modified(), and PMMLBasicsTestLauncher::ret.

 {
   StaticDefinedComposedNode::edRemoveChild(_node);
   Node *ret=_node;
   _node=0;
   modified();
   return ret;
 }

Node * Loop::edSetNode ( Node * DISOWNnode )

Definition at line 325 of file Loop.cxx.

References YACS::ENGINE::Node::_father, _node, YACS::ENGINE::ComposedNode::checkNoCrossHierachyWith(), YACS::ENGINE::ComposedNode::edRemoveChild(), YACS::ENGINE::Node::getName(), YACS::ENGINE::Node::modified(), and PMMLBasicsTestLauncher::ret.

 {
   if(_node==node)
     return 0;
   if(node)
     {
       if(node->_father)
         {
           string what = "Loop::edSetNode: node "; what += node->getName(); what += " is not orphan ! "; 
           throw Exception(what);
         }
     }
   checkNoCrossHierachyWith(node);
   StaticDefinedComposedNode::edRemoveChild(_node);
   Node *ret=_node;
   _node=node;
   _node->_father=this;
   //set _modified flag so that edUpdateState() can refresh state
   modified();
   return ret;
 }

Node * Loop::getChildByShortName ( const std::string & name ) const throw (Exception)

virtual

Implements YACS::ENGINE::ComposedNode.

Definition at line 422 of file Loop.cxx.

 {
   if (_node)
     if(name==_node->getName())
       return _node;
   string what("node "); what+= name ; what+=" is not a child of loop node "; what += getName();
   throw Exception(what);
 }

virtual InputPort* YACS::ENGINE::Loop::getDecisionPort ( ) const

pure virtual

Returns the port which value is used to take decision about the continuation of the loop.

Implemented in YACS::ENGINE::ForLoop, and YACS::ENGINE::WhileLoop.

Referenced by checkControlDependancy(), and getSetOfInputPort().

void Loop::getDelegateOf	(	InPort *&	port,
		OutPort *	initialStart,
		const std::list< ComposedNode * > &	pointsOfView
	)		throw (Exception)

protectedvirtual

Reimplemented from YACS::ENGINE::ComposedNode.

Definition at line 498 of file Loop.cxx.

References YACS::ENGINE::DataPort::getName(), YACS::ENGINE::InputPort::NAME, and YACS::ENGINE::OutputPort::NAME.

 {
   string typeOfPortInstance=port->getNameOfTypeOfCurrentInstance();
   if(typeOfPortInstance!=InputPort::NAME ||
      (typeOfPortInstance == InputPort::NAME && 
       initialStart->getNameOfTypeOfCurrentInstance()== OutputPort::NAME && 
       !isNecessaryToBuildSpecificDelegateDF2DS(pointsOfView)) )
     return ;
   InputPort *portCasted=(InputPort *)port;
   set<DSToDFForLoop*>::iterator iter;
   for(iter=_inputsTraducer.begin();iter!=_inputsTraducer.end();iter++)
     if((*iter)->getOutputPort("")->isAlreadyInSet(portCasted))
       break;
   if(iter==_inputsTraducer.end())
     {
       string what("Loop::getDelegateOf : Port with name "); what+=portCasted->getName(); what+=" not exported by loop "; what+=_name; 
       throw Exception(what);
     }
   else
     port=(*iter)->getInputDataStreamPort("");
 }

void Loop::getDelegateOf	(	std::pair< OutPort , OutPort > &	port,
		InPort *	finalTarget,
		const std::list< ComposedNode * > &	pointsOfView
	)		throw (Exception)

protectedvirtual

Reimplemented from YACS::ENGINE::ComposedNode.

Definition at line 520 of file Loop.cxx.

References YACS::ENGINE::DataPort::getName(), YACS::ENGINE::OutPort::isAlreadyLinkedWith(), YACS::ENGINE::InputPort::NAME, and YACS::ENGINE::OutputPort::NAME.

 {
   string typeOfPortInstance=(port.first)->getNameOfTypeOfCurrentInstance();
   if(typeOfPortInstance!=OutputPort::NAME ||
     ( typeOfPortInstance == OutputPort::NAME && 
       finalTarget->getNameOfTypeOfCurrentInstance()== InputPort::NAME && 
       !isNecessaryToBuildSpecificDelegateDF2DS(pointsOfView)) )
     return ;
   OutPort *portCasted=port.first;
   set<DFToDSForLoop*>::iterator iter;
   for(iter=_outputsTraducer.begin();iter!=_outputsTraducer.end();iter++)
     if(portCasted->isAlreadyLinkedWith((*iter)->getInputPort("")))
       break;
   if(iter==_outputsTraducer.end())
     {
       string what("Loop::getDelegateOf : Port with name "); what+=portCasted->getName(); what+=" not exported by loop "; what+=_name; 
       throw Exception(what);
     }
   else
     port.first=(*iter)->getOutputDataStreamPort("");
 }

int Loop::getMaxLevelOfParallelism ( ) const

virtual

Implements YACS::ENGINE::Node.

Definition at line 415 of file Loop.cxx.

References _node, and YACS::ENGINE::Node::getMaxLevelOfParallelism().

 {
   if(!_node)
     return 0;
   return _node->getMaxLevelOfParallelism();
 }

int YACS::ENGINE::Loop::getNbOfTurns ( ) const

inline

Definition at line 161 of file Loop.hxx.

Referenced by YACS::ENGINE::ForLoop::getProgressWeight(), YACS::ENGINE::VisitorSaveState::visitForLoop(), YACS::ENGINE::VisitorSaveState::visitLoop(), and YACS::ENGINE::VisitorSaveState::visitWhileLoop().

161 { return _nbOfTurns; }

int Loop::getNumberOfInputPorts ( ) const

virtual

Reimplemented from YACS::ENGINE::ComposedNode.

Definition at line 410 of file Loop.cxx.

References YACS::ENGINE::ComposedNode::getNumberOfInputPorts().

 {
   return StaticDefinedComposedNode::getNumberOfInputPorts()+1;
 }

void Loop::getReadyTasks ( std::vector< Task * > & tasks )

virtual

Collect all the child nodes that are ready.

Parameters

tasks : vector of tasks to collect ready nodes

Implements YACS::ENGINE::Node.

Definition at line 365 of file Loop.cxx.

References _inputsTraducer, _node, _nodeForNullTurnOfLoops, _outputsTraducer, YACS::ENGINE::Node::_state, YACS::ACTIVATED, YACS::ENGINE::ElementaryNode::getReadyTasks(), YACS::ENGINE::Node::getReadyTasks(), YACS::ENGINE::Node::setState(), and YACS::TOACTIVATE.

 {
   if(!_node)
     return;
   /*
    * To change the way ComposedNode state is handled, uncomment the following line
    * see Bloc::getReadyTasks
    */
   if(_state==YACS::TOACTIVATE) setState(YACS::ACTIVATED);
   if(_state==YACS::TOACTIVATE || _state==YACS::ACTIVATED)
     if(_nodeForNullTurnOfLoops)
       _nodeForNullTurnOfLoops->getReadyTasks(tasks);
     else
       {
         _node->getReadyTasks(tasks);
         for(set<DSToDFForLoop *>::iterator iter1=_inputsTraducer.begin();iter1!=_inputsTraducer.end();iter1++)
           (*iter1)->getReadyTasks(tasks);
         for(set<DFToDSForLoop *>::iterator iter2=_outputsTraducer.begin();iter2!=_outputsTraducer.end();iter2++)
           (*iter2)->getReadyTasks(tasks);
       }
 }

std::list< InputPort * > Loop::getSetOfInputPort ( ) const

virtual

Reimplemented from YACS::ENGINE::ComposedNode.

Definition at line 403 of file Loop.cxx.

References getDecisionPort(), YACS::ENGINE::ComposedNode::getSetOfInputPort(), and PMMLBasicsTestLauncher::ret.

 {
   list<InputPort *> ret=StaticDefinedComposedNode::getSetOfInputPort();
   ret.push_back(getDecisionPort());
   return ret;
 }

void Loop::init ( bool start = true )

virtual

initialisation of all input and output ports and gates, for execution

Reimplemented from YACS::ENGINE::ComposedNode.

Reimplemented in YACS::ENGINE::WhileLoop.

Definition at line 313 of file Loop.cxx.

References _nbOfTurns, _node, _nodeForNullTurnOfLoops, YACS::ENGINE::ComposedNode::init(), and YACS::ENGINE::Node::init().

Referenced by YACS::ENGINE::ForLoop::init(), and YACS::ENGINE::WhileLoop::init().

 {
   StaticDefinedComposedNode::init(start);
   _nbOfTurns=0;
   if(_node)
     _node->init(start); // if start is true, refresh the internal node
   else
     throw Exception("Loop::initLoop : no nodes specifies to be repeated ");
   delete _nodeForNullTurnOfLoops;
   _nodeForNullTurnOfLoops=0;
 }

bool Loop::isNecessaryToBuildSpecificDelegateDF2DS ( const std::list< ComposedNode * > & pointsOfView )

staticprotected

Note: : States if a DF port must be considered on an upper level in hierarchy as a DS port or not from 'pointsOfView' observers.

Returns

:

True : a traduction DF->DS has to be done
False : no traduction needed

Definition at line 612 of file Loop.cxx.

References PMMLBasicsTestLauncher::ret.

Referenced by buildDelegateOf().

 {
   bool ret=false;
   for(list<ComposedNode *>::const_iterator iter=pointsOfView.begin();iter!=pointsOfView.end() && !ret;iter++)
     ret=(*iter)->isRepeatedUnpredictablySeveralTimes();
   return ret;
 }

bool YACS::ENGINE::Loop::isRepeatedUnpredictablySeveralTimes ( ) const

inlinevirtual

Reimplemented from YACS::ENGINE::ComposedNode.

Definition at line 171 of file Loop.hxx.

171 { return true; }

TypeCode * Loop::MappingDF2DS ( TypeCode * type ) throw (Exception)

static

Definition at line 431 of file Loop.cxx.

Referenced by buildDelegateOf(), and YACS::ENGINE::DFToDSForLoop::DFToDSForLoop().

 {
   return type;
 }

TypeCode * Loop::MappingDS2DF ( TypeCode * type ) throw (Exception)

static

Definition at line 436 of file Loop.cxx.

 {
   return type;
 }

void Loop::releaseDelegateOf	(	InPort *&	port,
		OutPort *	initialStart,
		const std::list< ComposedNode * > &	pointsOfView
	)		throw (Exception)

protectedvirtual

Reimplemented from YACS::ENGINE::ComposedNode.

Definition at line 543 of file Loop.cxx.

References YACS::ENGINE::DataPort::getName(), YACS::ENGINE::InputPort::NAME, and YACS::ENGINE::OutputPort::NAME.

 {
   string typeOfPortInstance=port->getNameOfTypeOfCurrentInstance();
   if(typeOfPortInstance!=InputPort::NAME ||
     ( typeOfPortInstance == InputPort::NAME && 
       initialStart->getNameOfTypeOfCurrentInstance()== OutputPort::NAME && 
       !isNecessaryToBuildSpecificDelegateDF2DS(pointsOfView)) )
     return ;
   InputPort *portCasted=(InputPort *)port;
   set<DSToDFForLoop*>::iterator iter;
   for(iter=_inputsTraducer.begin();iter!=_inputsTraducer.end();iter++)
     if((*iter)->getOutputPort("")->isAlreadyInSet(portCasted))
       break;
   if(iter==_inputsTraducer.end())
     {
       string what("Loop::releaseDelegateOf Port with name "); what+=portCasted->getName(); what+=" not exported by loop "; what+=_name; 
       throw Exception(what);
     }
   else
     {
       port=(*iter)->getInputDataStreamPort("");
       if((*iter)->loopHasOneLessRef())
         {
           (*iter)->getOutputPort("")->removeInPort(portCasted,false);
           delete (*iter);
           _inputsTraducer.erase(iter);
         }
     }
 }

void Loop::releaseDelegateOf	(	OutPort *	portDwn,
		OutPort *	portUp,
		InPort *	finalTarget,
		const std::list< ComposedNode * > &	pointsOfView
	)		throw (Exception)

protectedvirtual

Reimplemented from YACS::ENGINE::ComposedNode.

Definition at line 573 of file Loop.cxx.

 {
   if(portDwn==portUp)
     return ;
   set<DFToDSForLoop*>::iterator iter;
   for(iter=_outputsTraducer.begin();iter!=_outputsTraducer.end();iter++)
     if((*iter)->getOutputDataStreamPort("")==portUp)
       break;
   if((*iter)->loopHasOneLessRef())
     {
       portDwn->removeInPort((*iter)->getInputPort(""),false);
       delete (*iter);
       _outputsTraducer.erase(iter);
     }
 }

virtual std::string YACS::ENGINE::Loop::typeName ( )

inlinevirtual

Reimplemented from YACS::ENGINE::ComposedNode.

Reimplemented in YACS::ENGINE::ForLoop, and YACS::ENGINE::WhileLoop.

Definition at line 182 of file Loop.hxx.

182 {return "YACS__ENGINE__Loop";}

void Loop::writeDot ( std::ostream & os ) const

virtual

Dump the node state to a stream.

Parameters

os	: the output stream

Reimplemented from YACS::ENGINE::Node.

Definition at line 638 of file Loop.cxx.

References _node, YACS::ENGINE::Node::getColorState(), YACS::ENGINE::Node::getEffectiveState(), YACS::ENGINE::Node::getId(), YACS::ENGINE::Node::getQualifiedName(), CORBAEngineTest::state, and YACS::ENGINE::Node::writeDot().

 {
   os << "  subgraph cluster_" << getId() << "  {\n" ;
   //only one node in a loop
   if(_node)
     {
       _node->writeDot(os);
       os << getId() << " -> " << _node->getId() << ";\n";
     }
   os << "}\n" ;
   os << getId() << "[fillcolor=\"" ;
   YACS::StatesForNode state=getEffectiveState();
   os << getColorState(state);
   os << "\" label=\"" << "Loop:" ;
   os << getQualifiedName() <<"\"];\n";
 }