Control node that emulates the C switch. More...

#include <Switch.hxx>

Inheritance diagram for YACS::ENGINE::Switch:

[legend]

Collaboration diagram for YACS::ENGINE::Switch:

[legend]

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

	Switch (const std::string &name)

	~Switch ()

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

void	init (bool start=true)

Node *	edSetDefaultNode (Node *DISOWNnode)

Node *	edReleaseDefaultNode ()

Node *	edReleaseCase (int caseId)

Node *	edGetNode (int caseId)

Node *	edSetNode (int caseId, Node *DISOWNnode)

void	edChangeCase (int oldCase, int newCase)
	Change the case of a node. More...

virtual bool	edAddChild (Node *DISOWNnode)

int	getMaxCase ()

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

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

InputPort *	edGetConditionPort ()

void	writeDot (std::ostream &os) const
	Dump to the input stream a dot representation of the node. More...

int	getNumberOfInputPorts () const

int	getMaxLevelOfParallelism () const

void	getWeightRegardingDPL (ComplexWeight *weight)

void	partitionRegardingDPL (const PartDefinition pd, std::map< ComposedNode , YACS::BASES::AutoRefCnt< PartDefinition > > &zeMap)

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

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

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

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

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

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

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

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

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

std::string	getCaseId (const Node *node) const

virtual void	accept (Visitor *visitor)

int	getRankOfNode (Node *node) const

virtual std::string	typeName ()

std::list< ProgressWeight >	getProgressWeight () const
	Get the progress weight of the graph. More...

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 ()

void	init (bool start=true)

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
	Perform check of deployment consistency of the current graph. More...

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

virtual bool	isPlacementPredictableB4Run () const =0

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)
	Add a dataflow link between two data ports. More...

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

virtual bool	edAddChild (Node *DISOWNnode)

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

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

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

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

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

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

virtual bool	isRepeatedUnpredictablySeveralTimes () const

virtual bool	isLoop () const

virtual std::list< Node * >	edGetDirectDescendants () const =0

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
	Get the input port name. More...

std::string	getOutPortName (const OutPort *) const

int	getNumberOfInputPorts () const

int	getNumberOfOutputPorts () const

std::list< InputPort * >	getSetOfInputPort () 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

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

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

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

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

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

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

void	checkConsistency (LinkInfo &info) const

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

virtual std::string	typeName ()

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

virtual void	checkBasicConsistency () const

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

ComposedNode *	getRootNode () const

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

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

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

void	loaded ()

void	connected ()

void	accept (Visitor *visitor)

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

virtual std::string	getProgress () const

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

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

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

virtual void	init (bool start=true)

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

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

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	writeDot (std::ostream &os) const
	Dump to the input stream a dot representation of the node. More...

void	writeDotInFile (const std::string &fileName) 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...

virtual void	getReadyTasks (std::vector< Task * > &tasks)=0

virtual std::list< ElementaryNode * >	getRecursiveConstituents () const =0

virtual std::list< ProgressWeight >	getProgressWeight () const =0

virtual int	getNumberOfInputPorts () const =0

virtual int	getNumberOfOutputPorts () const =0

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

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

virtual std::list< InputPort * >	getSetOfInputPort () const =0

virtual std::list< OutputPort * >	getSetOfOutputPort () const =0

virtual std::list< InputPort * >	getLocalInputPorts () const =0

virtual std::list< OutputPort * >	getLocalOutputPorts () const =0

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...

virtual std::string	getInPortName (const InPort *) const =0

virtual std::string	getOutPortName (const OutPort *) const =0

virtual std::list< InputDataStreamPort * >	getSetOfInputDataStreamPort () const =0

virtual std::list< OutputDataStreamPort * >	getSetOfOutputDataStreamPort () const =0

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

InPropertyPort *	getInPropertyPort () const

virtual OutPort *	getOutPort (const std::string &name) const

virtual std::set< OutPort * >	getAllOutPortsLeavingCurrentScope () const =0

virtual std::set< InPort * >	getAllInPortsComingFromOutsideOfCurrentScope () const =0

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

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

virtual InputPort *	getInputPort (const std::string &name) const

virtual OutputPort *	getOutputPort (const std::string &name) const =0

virtual InputDataStreamPort *	getInputDataStreamPort (const std::string &name) const =0

virtual OutputDataStreamPort *	getOutputDataStreamPort (const std::string &name) const =0

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

bool	operator> (const Node &other) const

bool	operator< (const Node &other) const

std::string	getImplementation () const

DynParaLoop *	getClosestDPLAmongAncestors () const

virtual ComposedNode *	getRootNode () 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 Node *	getChildByName (const std::string &name) const =0

virtual Proc *	getProc ()

virtual const Proc *	getProc () const

virtual void	accept (Visitor *visitor)=0

virtual int	getMaxLevelOfParallelism () const =0

virtual void	getWeightRegardingDPL (ComplexWeight *weight)=0

virtual void	partitionRegardingDPL (const PartDefinition pd, std::map< ComposedNode , YACS::BASES::AutoRefCnt< PartDefinition > > &zeMap)=0

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	typeName ()

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 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...

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)

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

Public Member Functions inherited from YACS::ENGINE::Scheduler
virtual void	init (bool start=true)=0

virtual bool	isFinished ()=0

virtual void	exUpdateState ()=0

virtual std::string	getName () const =0

virtual std::string	getTaskName (Task *task) const =0

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

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

virtual void	notifyFrom (const Task sender, YACS::Event event, const Executor execInst)=0

virtual DeploymentTree	getDeploymentTree () const =0

virtual bool	isPlacementPredictableB4Run () const =0

virtual bool	isMultiplicitySpecified (unsigned &value) const =0

virtual void	forceMultiplicity (unsigned value)=0

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

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

virtual	~Scheduler ()

Static Public Attributes
static const char	DEFAULT_NODE_NAME [] ="default"

static const char	SELECTOR_INPUTPORT_NAME [] ="select"

static const int	ID_FOR_DEFAULT_NODE =-1973012217

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

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

Protected Member Functions
YACS::Event	updateStateOnFinishedEventFrom (Node *node)

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

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

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

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

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

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

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

void	checkControlDependancy (OutPort start, InPort end, bool cross, std::map< ComposedNode , std::list< OutPort > > &fw, std::vector< OutPort * > &fwCross, std::map< ComposedNode , std::list< OutPort > > &bw, LinkInfo &info) const

void	checkNoCyclePassingThrough (Node *node)

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 ()

virtual Node *	getChildByShortName (const std::string &name) const =0

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)

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

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

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

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

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

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

virtual void	checkNoCyclePassingThrough (Node *node)=0

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

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

void	checkNoCrossHierachyWith (Node *node) const

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

virtual 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 =0

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

virtual 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::Node
	Node (const std::string &name)

	Node (const Node &other, ComposedNode *father)

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

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

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

virtual void	exForwardFailed ()

virtual void	exForwardFinished ()

virtual void	edDisconnectAllLinksWithMe ()

Protected Attributes
AnyInputPort	_condition

std::map< int, Node * >	_mapOfNode

FakeNodeForSwitch *	_undispatchableNotificationNode

std::map< InPort , CollectorSwOutPort >	_outPortsCollector

std::vector< CollectorSwOutPort * >	_alreadyExistingCollectors

Protected Attributes inherited from YACS::ENGINE::Node
InGate	_inGate

OutGate	_outGate

InPropertyPort *	_inPropertyPort

std::string	_name

ComposedNode *	_father

YACS::StatesForNode	_state

int	_modified

std::string	_errorDetails

int	_numId

std::string	_implementation

std::map< std::string, std::string >	_propertyMap

Node *	_eventReceiver =nullptr

Private Member Functions
int	getNbOfCases () const

Static Private Member Functions
static std::string	getRepresentationOfCase (int i)

Friends
class	FakeNodeForSwitch

class	CollectorSwOutPort

Additional Inherited Members
Static Public Member Functions inherited from YACS::ENGINE::ComposedNode
static ComposedNode *	getLowestCommonAncestor (Node node1, Node node2)
	Retrieves the lowest common ancestor of 2 nodes. More...

static std::string	getLowestCommonAncestorStr (const std::string &node1, const std::string &node2)

Static Public Member Functions inherited from YACS::ENGINE::Node
static std::string	getStateName (YACS::StatesForNode state)
	Return the name of a state. More...

static void	checkValidityOfNodeName (const std::string &name)

Public Attributes inherited from YACS::ENGINE::Node
YACS::Colour	_colour

Static Protected Member Functions inherited from YACS::ENGINE::ComposedNode
static bool	splitNamesBySep (const std::string &globalName, const char separator[], std::string &firstPart, std::string &lastPart, bool priority)
	Splits name globalName in 2 parts using separator. More...

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

static ComposedNode *	checkHavingCommonFather (Node node1, Node node2)

Static Protected Attributes inherited from YACS::ENGINE::ComposedNode
static const unsigned char	FED_ST = 2

static const unsigned char	FREE_ST = 0

static const unsigned char	FED_DS_ST = 1

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

static int	_total = 0

Detailed Description

Control node that emulates the C switch.

Definition at line 84 of file Switch.hxx.

Constructor & Destructor Documentation

◆ Switch() [1/2]

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

Definition at line 285 of file Switch.cxx.

                                                                         :StaticDefinedComposedNode(other,father),_condition(other._condition,this),
                                                                            _undispatchableNotificationNode(0)
{
  for(map<int,Node *>::const_iterator iter=other._mapOfNode.begin();iter!=other._mapOfNode.end();iter++)
    _mapOfNode[(*iter).first]=(*iter).second->clone(this,editionOnly);
  if(!editionOnly)
    for(map<InPort *, CollectorSwOutPort * >::const_iterator iter2=other._outPortsCollector.begin();iter2!=other._outPortsCollector.end();iter2++)
      {
        CollectorSwOutPort *newCol=new CollectorSwOutPort(*((*iter2).second),this);
        _alreadyExistingCollectors.push_back(newCol);
      }
}

References _alreadyExistingCollectors, _mapOfNode, _outPortsCollector, and CollectorSwOutPort.

◆ Switch() [2/2]

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

Definition at line 298 of file Switch.cxx.

                                   :StaticDefinedComposedNode(name),_condition(SELECTOR_INPUTPORT_NAME,this,Runtime::_tc_int),_undispatchableNotificationNode(0)
{
}

◆ ~Switch()

Switch::~Switch ( )

Definition at line 302 of file Switch.cxx.

{
  if(_undispatchableNotificationNode)delete _undispatchableNotificationNode;
 
  for(map< int , Node * >::iterator iter=_mapOfNode.begin();iter!=_mapOfNode.end();iter++)
    delete (*iter).second;
  for(map<InPort *, CollectorSwOutPort * >::iterator iter2=_outPortsCollector.begin();iter2!=_outPortsCollector.end();iter2++)
    delete (*iter2).second;
  for(vector<CollectorSwOutPort *>::iterator iter3=_alreadyExistingCollectors.begin();iter3!=_alreadyExistingCollectors.end();iter3++)
    delete (*iter3);
}

References _alreadyExistingCollectors, _mapOfNode, _outPortsCollector, and _undispatchableNotificationNode.

Member Function Documentation

◆ accept()

void Switch::accept ( Visitor * visitor )

virtual

Reimplemented from YACS::ENGINE::ComposedNode.

Definition at line 838 of file Switch.cxx.

{
  visitor->visitSwitch(this);
}

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

◆ buildDelegateOf()

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

protectedvirtual

Reimplemented from YACS::ENGINE::ComposedNode.

Definition at line 701 of file Switch.cxx.

{
  map<InPort *, CollectorSwOutPort * >::iterator result=_outPortsCollector.find(finalTarget);
  CollectorSwOutPort *newCollector;
  if(result!=_outPortsCollector.end())
    newCollector=(*result).second;
  else
    {
      newCollector=new CollectorSwOutPort(this,finalTarget);
      newCollector->edSetType((port.first)->edGetType());
      _outPortsCollector[finalTarget]=newCollector;
    }
  newCollector->addPotentialProducerForMaster(port.first);
  port.second=newCollector;
  port.first=newCollector;
}

References _outPortsCollector, YACS::ENGINE::CollectorSwOutPort::addPotentialProducerForMaster(), CollectorSwOutPort, and YACS::ENGINE::DataPort::edSetType().

◆ checkCFLinks()

void Switch::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 661 of file Switch.cxx.

{
  map<InPort *, CollectorSwOutPort * >::const_iterator iter=_outPortsCollector.find(end);
  if(iter!=_outPortsCollector.end())
    {
      set<OutPort *> represented;
      (*iter).second->getAllRepresented(represented);
      list<OutPort *> others;
      for(list<OutPort *>::const_iterator iter2=starts.begin();iter2!=starts.end();iter2++)
        if(represented.find(*iter2)==represented.end())
          others.push_back(*iter2);
      if(others.empty())
        alreadyFed=FED_ST;
      else
        StaticDefinedComposedNode::checkCFLinks(others,end,alreadyFed,direction,info);//should never happend;
    }
  else
    StaticDefinedComposedNode::checkCFLinks(starts,end,alreadyFed,direction,info);
}

References _outPortsCollector, YACS::ENGINE::ComposedNode::checkCFLinks(), and YACS::ENGINE::ComposedNode::FED_ST.

◆ checkControlDependancy()

void Switch::checkControlDependancy	(	OutPort *	start,
		InPort *	end,
		bool	cross,
		std::map< ComposedNode , std::list< OutPort > > &	fw,
		std::vector< OutPort * > &	fwCross,
		std::map< ComposedNode , std::list< OutPort > > &	bw,
		LinkInfo &	info
	)		const

protected

Definition at line 681 of file Switch.cxx.

{
  throw Exception("Switch::checkControlDependancy : a link was dectected between 2 cases of a switch. Impossible !");
}

◆ checkLinkPossibility()

void Switch::checkLinkPossibility	(	OutPort *	start,
		const std::list< ComposedNode * > &	pointsOfViewStart,
		InPort *	end,
		const std::list< ComposedNode * > &	pointsOfViewEnd
	)

protectedvirtual

Reimplemented from YACS::ENGINE::ComposedNode.

Definition at line 695 of file Switch.cxx.

{
  throw Exception("Switch::checkLinkPossibility : A link between 2 different cases of a same Switch requested -> Impossible");
}

◆ checkNoCyclePassingThrough()

void Switch::checkNoCyclePassingThrough ( Node * node )

protectedvirtual

Implements YACS::ENGINE::ComposedNode.

Definition at line 690 of file Switch.cxx.

{
  throw Exception("Switch::checkNoCyclePassingThrough : uncorrect control flow link relative to switch");
}

◆ edAddChild()

bool Switch::edAddChild ( Node * DISOWNnode )

virtual

Reimplemented from YACS::ENGINE::ComposedNode.

Definition at line 633 of file Switch.cxx.

{
  int aCase = getMaxCase() + 1;
  DEBTRACE(aCase);
  bool ret = edSetNode(aCase, node);
  DEBTRACE(ret);
  return ret;
}

References DEBTRACE, edSetNode(), and getMaxCase().

◆ edChangeCase()

void Switch::edChangeCase	(	int	oldCase,
		int	newCase
	)

Change the case of a node.

Parameters

oldCase	: the case value to change
newCase	: the new value to set raise an exception if the old case does not exist or if the new case already exists

Definition at line 575 of file Switch.cxx.

{
  std::map< int , Node * >::iterator iter=_mapOfNode.find(oldCase);
  if(iter==_mapOfNode.end())
    {
      //the case does not exists
      throw Exception("Switch::edChangeCase : case does not exist");
    }
  iter=_mapOfNode.find(newCase);
  if(iter != _mapOfNode.end())
    {
      //the new case exists
      throw Exception("Switch::edChangeCase : new case exists");
    }
  Node* node=_mapOfNode[oldCase];
  _mapOfNode.erase(oldCase);
  _mapOfNode[newCase]=node;
  modified();
}

References _mapOfNode, and YACS::ENGINE::Node::modified().

Referenced by YACS::HMI::CommandSetSwitchCase::localExecute(), and YACS::HMI::CommandSetSwitchCase::localReverse().

◆ edGetConditionPort()

InputPort * YACS::ENGINE::Switch::edGetConditionPort ( )

inline

Definition at line 115 of file Switch.hxx.

115{ return &_condition; }

Referenced by YACS::HMI::SubjectSwitch::getValue(), YACS::HMI::CommandSetSwitchSelect::localExecute(), YACS::HMI::CommandSetSwitchSelect::localReverse(), YACS::ENGINE::nodeParser::onEnd(), YACS::switchtypeParser::select(), YACS::ENGINE::VisitorSaveSchema::visitSwitch(), and YACS::ENGINE::VisitorSaveState::visitSwitch().

◆ edGetDirectDescendants()

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

virtual

Implements YACS::ENGINE::ComposedNode.

Definition at line 393 of file Switch.cxx.

{
  list<Node *> ret;
  for(map< int , Node * >::const_iterator iter=_mapOfNode.begin();iter!=_mapOfNode.end();iter++)
    if((*iter).second)
      ret.push_back((*iter).second);
  return ret;
}

References _mapOfNode.

Referenced by getProgressWeight().

◆ edGetNode()

Node * Switch::edGetNode ( int caseId )

Definition at line 527 of file Switch.cxx.

{
  if (!_mapOfNode.count(caseId)) return 0;
  return _mapOfNode[caseId];
}

References _mapOfNode.

Referenced by YACS::HMI::CommandSetSwitchCase::localExecute(), YACS::HMI::CommandSetSwitchCase::localReverse(), YACS::HMI::SceneComposedNodeItem::update(), and YACS::HMI::SchemaComposedNodeItem::update().

◆ edReleaseCase()

Node * Switch::edReleaseCase ( int caseId )

Definition at line 509 of file Switch.cxx.

{
  map< int , Node * >::iterator iter=_mapOfNode.find(caseId);
  if(iter==_mapOfNode.end())
    { 
      string what("Switch::edReleaseCase : the case # "); what+=getRepresentationOfCase(caseId);  what+=" is not set yet.";
      throw Exception(what);
    }
  else
    {
      Node *ret=(*iter).second;
      StaticDefinedComposedNode::edRemoveChild(ret);
      _mapOfNode.erase(iter);
      modified();
      return ret;
    }
}

References _mapOfNode, YACS::ENGINE::ComposedNode::edRemoveChild(), getRepresentationOfCase(), and YACS::ENGINE::Node::modified().

Referenced by edReleaseDefaultNode(), and edRemoveChild().

◆ edReleaseDefaultNode()

Node * Switch::edReleaseDefaultNode ( )

Definition at line 504 of file Switch.cxx.

{
  return edReleaseCase(ID_FOR_DEFAULT_NODE);
}

References edReleaseCase(), and ID_FOR_DEFAULT_NODE.

◆ edRemoveChild()

void Switch::edRemoveChild ( Node * node )

virtual

Remove a child node.

Reimplemented from YACS::ENGINE::ComposedNode.

Definition at line 432 of file Switch.cxx.

{
  map< int , Node * >::iterator iter=_mapOfNode.begin();
  for(;iter!=_mapOfNode.end();iter++)
    if(node==(*iter).second)
      {
        edReleaseCase((*iter).first);
        return;
      }
  ostringstream what; what << "Switch::edRemoveChild : node with name " << node->getName() << " is not a direct child of Switch node " << _name; 
  throw Exception(what.str());
}

References _mapOfNode, YACS::ENGINE::Node::_name, edReleaseCase(), and YACS::ENGINE::Node::getName().

◆ edSetDefaultNode()

Node * Switch::edSetDefaultNode ( Node * DISOWNnode )

Definition at line 499 of file Switch.cxx.

{
  return edSetNode(ID_FOR_DEFAULT_NODE,node);
}

References edSetNode(), and ID_FOR_DEFAULT_NODE.

Referenced by YACS::switchtypeParser::default_().

◆ edSetNode()

Node * Switch::edSetNode	(	int	caseId,
		Node *	node
	)

Parameters

caseId	: the case ID chosen to place 'node'
node	: the node for the specified 'caseId'

Returns: : If an old node with id equal to 'caseId' exists before, this old node is returned so that to be deallocated. 0 is returned if caseId is a new ID. WARNING : 'node' is held by 'this' after call, whereas returned node is no more held.

Definition at line 541 of file Switch.cxx.

{
  if(!node)
    throw Exception("Switch::edSetNode : null node cannot be set as a case in switch node");
  if(node->_father!=0)
    throw Exception("Switch::edSetNode : node already held by another father");
  checkNoCrossHierachyWith(node);
  node->_father=this;
  map< int , Node * >::iterator iter=_mapOfNode.find(caseId);
  if(iter==_mapOfNode.end())
    {
      _mapOfNode[caseId]=node;
      modified();
      return 0;
    }
  else
    {
      if(node!=(*iter).second)
        {
          Node *ret=(*iter).second;
          (*iter).second=node;
          modified();
          return ret;
        }
    }
  return 0;
}

References YACS::ENGINE::Node::_father, _mapOfNode, YACS::ENGINE::ComposedNode::checkNoCrossHierachyWith(), and YACS::ENGINE::Node::modified().

Referenced by YACS::switchtypeParser::case_(), edAddChild(), and edSetDefaultNode().

◆ exUpdateState()

void Switch::exUpdateState ( )

virtual

Update the node state.

Note: : Update the '_state' attribute. Typically called by 'this->_inGate' when 'this->_inGate' is ready.

Called by InGate::exNotifyFromPrecursor

Reimplemented from YACS::ENGINE::Node.

Definition at line 319 of file Switch.cxx.

{
  DEBTRACE("Switch::exUpdateState " << _state);
  if(_state == YACS::DISABLED)
    return;
  if(_inGate.exIsReady())
    {
      setState(YACS::ACTIVATED);
      if(_condition.isEmpty())
        _undispatchableNotificationNode=new FakeNodeForSwitch(this,false,true);
      else
        {
          map< int , Node * >::iterator iter=_mapOfNode.find(_condition.getIntValue());
          if(iter==_mapOfNode.end())
            {
              iter=_mapOfNode.find(ID_FOR_DEFAULT_NODE);
              if(iter==_mapOfNode.end())
                {
                  bool normalFinish=getAllOutPortsLeavingCurrentScope().empty();
                  delete _undispatchableNotificationNode;
                  _undispatchableNotificationNode=new FakeNodeForSwitch(this,normalFinish);
                }
              else
                ((*iter).second)->exUpdateState();
            }
          else
            ((*iter).second)->exUpdateState();
        }
    }
}

References _condition, YACS::ENGINE::Node::_inGate, _mapOfNode, YACS::ENGINE::Node::_state, _undispatchableNotificationNode, YACS::ACTIVATED, DEBTRACE, YACS::DISABLED, YACS::ENGINE::InGate::exIsReady(), FakeNodeForSwitch, YACS::ENGINE::ComposedNode::getAllOutPortsLeavingCurrentScope(), YACS::ENGINE::AnyInputPort::getIntValue(), ID_FOR_DEFAULT_NODE, YACS::ENGINE::AnyInputPort::isEmpty(), and YACS::ENGINE::Node::setState().

◆ getAllInPortsComingFromOutsideOfCurrentScope()

std::set< InPort * > Switch::getAllInPortsComingFromOutsideOfCurrentScope ( ) const

protectedvirtual

List all input ports that are linked to out of scope ports.

List all input ports of 'this' so that, for each it exists at least 1 link coming from outside to it.

Reimplemented from YACS::ENGINE::ComposedNode.

Definition at line 648 of file Switch.cxx.

{
  set<InPort *> ret=StaticDefinedComposedNode::getAllInPortsComingFromOutsideOfCurrentScope();
  set<OutPort *> temp2=_condition.edSetOutPort();
  for(set<OutPort *>::iterator iter3=temp2.begin();iter3!=temp2.end();iter3++)
    if(!isInMyDescendance((*iter3)->getNode()))
      {
        ret.insert((InPort *)&_condition);
        break;
      }
  return ret;
}

References _condition, YACS::ENGINE::InPort::edSetOutPort(), YACS::ENGINE::ComposedNode::getAllInPortsComingFromOutsideOfCurrentScope(), and YACS::ENGINE::ComposedNode::isInMyDescendance().

◆ getCaseId()

std::string Switch::getCaseId ( const Node * node ) const

Definition at line 819 of file Switch.cxx.

{
  const char sep='_';
  map<int, Node*>::const_iterator iter;
  for (iter = _mapOfNode.begin(); iter != _mapOfNode.end(); iter++)
      if (iter->second == node)
        {
          stringstream a;
          if (iter->first == Switch::ID_FOR_DEFAULT_NODE)
            a << DEFAULT_NODE_NAME << sep;
          else if (iter->first <0)
            a << "m" << -iter->first << sep;
          else a  << "p" << iter->first << sep; 
          return a.str();
        }
  string what("node "); what+= node->getName() ; what+=" is not a child of node "; what += getName();
  throw Exception(what);  
}

References _mapOfNode, gui.CONNECTOR::a, DEFAULT_NODE_NAME, YACS::ENGINE::ComposedNode::getName(), YACS::ENGINE::Node::getName(), and ID_FOR_DEFAULT_NODE.

Referenced by getMyQualifiedName().

◆ getChildByShortName()

Node * Switch::getChildByShortName ( const std::string & name ) const

virtual

Implements YACS::ENGINE::ComposedNode.

Definition at line 477 of file Switch.cxx.

{
  if(name==DEFAULT_NODE_NAME)
    {
      map< int , Node * >::const_iterator iter=_mapOfNode.find(ID_FOR_DEFAULT_NODE);
      if(iter!=_mapOfNode.end())
        return (Node *)((*iter).second);
      else
        {
          string what("Switch::getChildByShortName : no default node defined for switch of name "); what+=getName();
          throw Exception(what);
        }
    }
  for(map< int , Node * >::const_iterator iter=_mapOfNode.begin();iter!=_mapOfNode.end();iter++)
    {
      if(name==((*iter).second)->getQualifiedName())
        return (*iter).second;
    }
  string what("node "); what+= name ; what+=" is not a child of node switch "; what += getName();
  throw Exception(what);
}

References _mapOfNode, DEFAULT_NODE_NAME, YACS::ENGINE::ComposedNode::getName(), and ID_FOR_DEFAULT_NODE.

◆ getDelegateOf()

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

protectedvirtual

Reimplemented from YACS::ENGINE::ComposedNode.

Definition at line 718 of file Switch.cxx.

{
  map<InPort *, CollectorSwOutPort * >::iterator iter=_outPortsCollector.find(finalTarget);
  if(iter==_outPortsCollector.end())
    {
      string what("Switch::getDelegateOf : not exported OuputPort with name "); what+=(port.first)->getName(); what+=" for target inport of name ";
      what+=finalTarget->getName();
      throw Exception(what);
    }
  ((*iter).second)->checkManagementOfPort(port.first);
  port.second=(*iter).second;
  port.first=(*iter).second;
}

References _outPortsCollector, YACS::ENGINE::ComposedNode::getName(), and YACS::ENGINE::DataPort::getName().

◆ getEffectiveState() [1/2]

YACS::StatesForNode Switch::getEffectiveState ( ) const

virtual

Return the node state in the context of its father.

Returns: the effective node state

The node state is stored in a private attribute _state. This state is relative to its father state : a node with a TOACTIVATE state with a father node in a READY state is not to activate. Its effective state is only READY. This method returns the effective state of the node taking into account that of its father.

Reimplemented from YACS::ENGINE::Node.

Definition at line 790 of file Switch.cxx.

{
  return Node::getEffectiveState();
}

References YACS::ENGINE::Node::getEffectiveState().

Referenced by getProgressWeight().

◆ getEffectiveState() [2/2]

YACS::StatesForNode Switch::getEffectiveState ( const Node * node ) const

virtual

Return the effective state of a node in the context of this switch (its father)

Parameters

node	the node which effective state is queried

Returns: the effective node state

Reimplemented from YACS::ENGINE::Node.

Definition at line 778 of file Switch.cxx.

{
  YACS::StatesForNode effectiveState=Node::getEffectiveState();
  if(effectiveState==YACS::READY)
    return YACS::READY;
  if(effectiveState==YACS::TOACTIVATE)
    return YACS::READY;
  if(effectiveState==YACS::DISABLED)
    return YACS::DISABLED;
 
  return node->getState();
}

References YACS::DISABLED, YACS::ENGINE::Node::getEffectiveState(), YACS::ENGINE::Node::getState(), YACS::READY, and YACS::TOACTIVATE.

◆ getInputPort()

InputPort * Switch::getInputPort ( const std::string & name ) const

virtual

Get an input port given its name.

Contrary to YACS::ENGINE::ComposedNode::getOutputPort, this method is NOT recursive and so the leaf of type ElementaryNode aggregating this InputPort is directly invoked.

Reimplemented from YACS::ENGINE::ComposedNode.

Definition at line 470 of file Switch.cxx.

{
  if(name==SELECTOR_INPUTPORT_NAME)
    return (InputPort *)&_condition;
  return StaticDefinedComposedNode::getInputPort(name);
}

References _condition, YACS::ENGINE::ComposedNode::getInputPort(), and SELECTOR_INPUTPORT_NAME.

◆ getLocalInputPorts()

std::list< InputPort * > Switch::getLocalInputPorts ( ) const

virtual

redefined on derived class of ComposedNode. by default a ComposedNode has no port by itself

Reimplemented from YACS::ENGINE::ComposedNode.

Definition at line 453 of file Switch.cxx.

{
  list<InputPort *> ret=StaticDefinedComposedNode::getLocalInputPorts();
  ret.push_back((InputPort *)&_condition);
  return ret;
}

References _condition, and YACS::ENGINE::ComposedNode::getLocalInputPorts().

◆ getMaxCase()

int Switch::getMaxCase ( )

Definition at line 595 of file Switch.cxx.

{
  int aCase = 0;
  map<int, Node*>::const_iterator it = _mapOfNode.begin();
  for(; it != _mapOfNode.end(); ++it)
    if ((*it).first > aCase)
      aCase = (*it).first;
  return aCase;
}

References _mapOfNode.

Referenced by edAddChild().

◆ getMaxLevelOfParallelism()

int Switch::getMaxLevelOfParallelism ( ) const

virtual

Implements YACS::ENGINE::Node.

Definition at line 407 of file Switch.cxx.

{
  int ret(0);
  for(std::map< int , Node * >::const_iterator it=_mapOfNode.begin();it!=_mapOfNode.end();it++)
    ret=std::max(ret,((*it).second)->getMaxLevelOfParallelism());
  return ret;
}

References _mapOfNode.

◆ getMyQualifiedName()

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

virtual

Reimplemented from YACS::ENGINE::ComposedNode.

Definition at line 812 of file Switch.cxx.

{
  string id=getCaseId(directSon);
  id+=directSon->getName();
  return id;
}

References getCaseId(), and YACS::ENGINE::Node::getName().

◆ getNbOfCases()

int Switch::getNbOfCases ( ) const

private

Definition at line 747 of file Switch.cxx.

{
  return _mapOfNode.size();
}

References _mapOfNode.

◆ getNumberOfInputPorts()

int Switch::getNumberOfInputPorts ( ) const

virtual

Reimplemented from YACS::ENGINE::ComposedNode.

Definition at line 402 of file Switch.cxx.

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

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

◆ getOutPort()

OutPort * Switch::getOutPort ( const std::string & name ) const

virtual

Note: : Contrary to getOutputPort method, this method returns the output port at highest level, possible. That is to say in some ComposedNode, like ForEachLoop or Switch, an outport inside 'this' is seen differently than the true outport.

Reimplemented from YACS::ENGINE::ComposedNode.

Definition at line 459 of file Switch.cxx.

{
  for(map<InPort *, CollectorSwOutPort * >::const_iterator iter=_outPortsCollector.begin();iter!=_outPortsCollector.end();iter++)
    if(name==(*iter).second->getName())
      return (*iter).second;
  for(vector<CollectorSwOutPort *>::const_iterator iter2=_alreadyExistingCollectors.begin();iter2!=_alreadyExistingCollectors.end();iter2++)
    if(name==(*iter2)->getName())
      return *iter2;
  return StaticDefinedComposedNode::getOutPort(name);
}

References _alreadyExistingCollectors, _outPortsCollector, and YACS::ENGINE::ComposedNode::getOutPort().

Referenced by YACS::ENGINE::CollectorSwOutPort::CollectorSwOutPort().

◆ getProgressWeight()

list< ProgressWeight > Switch::getProgressWeight ( ) const

virtual

Get the progress weight of the graph.

Only elementary nodes have weight. If the switch node is not done, we add the weight of all his descendants, otherwise only the weight of the used case count.

Reimplemented from YACS::ENGINE::ComposedNode.

Definition at line 610 of file Switch.cxx.

{
  list<ProgressWeight> ret;
  list<Node *> setOfNode=edGetDirectDescendants();
  if (getState() == YACS::DONE)
    {
      for(list<Node *>::const_iterator iter=setOfNode.begin();iter!=setOfNode.end();iter++)
      {
        if (getEffectiveState(*iter) == YACS::DONE)
          ret=(*iter)->getProgressWeight();
      }
    }
  else
    {
      for(list<Node *>::const_iterator iter=setOfNode.begin();iter!=setOfNode.end();iter++)
        {
          list<ProgressWeight> myCurrentSet=(*iter)->getProgressWeight();
          ret.insert(ret.end(),myCurrentSet.begin(),myCurrentSet.end());
        }
    }
  return ret;
}

References YACS::DONE, edGetDirectDescendants(), getEffectiveState(), and YACS::ENGINE::Node::getState().

◆ getRankOfNode()

int Switch::getRankOfNode ( Node * node ) const

Definition at line 752 of file Switch.cxx.

{
  Node *directSon=isInMyDescendance(node);
  for(map< int , Node * >::const_iterator iter=_mapOfNode.begin();iter!=_mapOfNode.end();iter++)
    if((*iter).second==directSon)
      return (*iter).first;
  throw Exception("Switch::getRankOfNode : node not in switch");
}

References _mapOfNode, and YACS::ENGINE::ComposedNode::isInMyDescendance().

Referenced by YACS::ENGINE::VisitorSaveSchema::beginCase(), YACS::HMI::SubjectSwitch::completeChildrenSubjectList(), YACS::ENGINE::VisitorSaveSchema::endCase(), YACS::HMI::SceneNodeItem::getHeaderLabel(), YACS::HMI::SubjectSwitch::houseKeepingAfterCutPaste(), YACS::HMI::CommandSetSwitchCase::localExecute(), YACS::HMI::CommandSetSwitchCase::localReverse(), YACS::HMI::SubjectSwitch::setCase(), YACS::HMI::SchemaComposedNodeItem::setCaseValue(), and YACS::HMI::SchemaNodeItem::setCaseValue().

◆ getReadyTasks()

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

virtual

Implements YACS::ENGINE::Node.

Definition at line 367 of file Switch.cxx.

{
  /*
   * 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)
    {
      map< int , Node * >::iterator iter=_mapOfNode.find(_condition.getIntValue());
      if(iter!=_mapOfNode.end())
        ((*iter).second)->getReadyTasks(tasks);
      else
        {
          iter=_mapOfNode.find(ID_FOR_DEFAULT_NODE);
          if(iter!=_mapOfNode.end())
            (*iter).second->getReadyTasks(tasks);//Default Node is returned
          else
            if(_undispatchableNotificationNode)
              _undispatchableNotificationNode->getReadyTasks(tasks);
            else
              throw Exception("Switch::getReadyTasks : internal error");
        }
    }
}

References _condition, _mapOfNode, YACS::ENGINE::Node::_state, _undispatchableNotificationNode, YACS::ACTIVATED, YACS::ENGINE::AnyInputPort::getIntValue(), YACS::ENGINE::ElementaryNode::getReadyTasks(), getReadyTasks(), ID_FOR_DEFAULT_NODE, YACS::ENGINE::Node::setState(), and YACS::TOACTIVATE.

Referenced by getReadyTasks().

◆ getRepresentationOfCase()

string Switch::getRepresentationOfCase ( int i )

staticprivate

Definition at line 761 of file Switch.cxx.

{
  if(i!=ID_FOR_DEFAULT_NODE)
    {
      ostringstream stream;
      stream << i;
      return stream.str();
    }
  else
    return DEFAULT_NODE_NAME;
}

References DEFAULT_NODE_NAME, yacsorb.CORBAEngineTest::i, and ID_FOR_DEFAULT_NODE.

Referenced by YACS::ENGINE::CollectorSwOutPort::addPotentialProducerForMaster(), edReleaseCase(), and YACS::ENGINE::CollectorSwOutPort::getHumanReprOfIncompleteCases().

◆ getSetOfInputPort()

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

virtual

Reimplemented from YACS::ENGINE::ComposedNode.

Definition at line 445 of file Switch.cxx.

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

References _condition, and YACS::ENGINE::ComposedNode::getSetOfInputPort().

◆ getWeightRegardingDPL()

void Switch::getWeightRegardingDPL ( ComplexWeight * weight )

virtual

Implements YACS::ENGINE::Node.

Definition at line 415 of file Switch.cxx.

{
  ComplexWeight localWeight;
  for(std::map< int , Node * >::const_iterator it=_mapOfNode.begin();it!=_mapOfNode.end();it++)
  {
    ((*it).second)->getWeightRegardingDPL(&localWeight);
    weight->max(localWeight);
    localWeight.setToZero();
  }
}

References _mapOfNode, getWeightRegardingDPL(), YACS::ENGINE::ComplexWeight::max(), and YACS::ENGINE::ComplexWeight::setToZero().

Referenced by getWeightRegardingDPL().

◆ init()

void Switch::init ( bool start = true )

virtual

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

Reimplemented from YACS::ENGINE::ComposedNode.

Definition at line 350 of file Switch.cxx.

{
  DEBTRACE("Switch::init " << start);
  StaticDefinedComposedNode::init(start);
  int i=0;
  for(map< int , Node * >::iterator iter=_mapOfNode.begin();iter!=_mapOfNode.end();iter++, i++)
    {
      if(!(*iter).second)
        {
          ostringstream stream;
          stream << "Switch::init : initialization failed due to unitialized branch of id " << (*iter).first;
          throw Exception(stream.str());
        }
      ((*iter).second)->init(start);
    }
}

References _mapOfNode, DEBTRACE, yacsorb.CORBAEngineTest::i, YACS::ENGINE::ComposedNode::init(), and init().

Referenced by init().

◆ partitionRegardingDPL()

void Switch::partitionRegardingDPL	(	const PartDefinition *	pd,
		std::map< ComposedNode *, YACS::BASES::AutoRefCnt< PartDefinition > > &	zeMap
	)

virtual

Implements YACS::ENGINE::Node.

Definition at line 426 of file Switch.cxx.

{
  for(std::map< int , Node * >::const_iterator it=_mapOfNode.begin();it!=_mapOfNode.end();it++)
    (*it).second->partitionRegardingDPL(pd,zeMap);
}

References _mapOfNode.

◆ releaseDelegateOf()

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

protectedvirtual

Reimplemented from YACS::ENGINE::ComposedNode.

Definition at line 732 of file Switch.cxx.

{
  set<OutPort *> repr;
  portDwn->getAllRepresented(repr);
  if(repr.size()==1)
    {
      CollectorSwOutPort *portCasted=dynamic_cast<CollectorSwOutPort *>(portUp);
      if(portCasted->removePotentialProducerForMaster())//normally always true
        {
          delete portCasted;
          _outPortsCollector.erase(finalTarget);
        }
    }
}

References _outPortsCollector, YACS::ENGINE::OutPort::getAllRepresented(), and YACS::ENGINE::CollectorSwOutPort::removePotentialProducerForMaster().

◆ simpleClone()

Node * Switch::simpleClone	(	ComposedNode *	father,
		bool	editionOnly = `true`
	)		const

protectedvirtual

Implements YACS::ENGINE::Node.

Definition at line 314 of file Switch.cxx.

{
  return new Switch(*this,father,editionOnly);
}

References YACS::ENGINE::Node::Switch.

◆ typeName()

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

inlinevirtual

Reimplemented from YACS::ENGINE::ComposedNode.

Definition at line 133 of file Switch.hxx.

133{return "YACS__ENGINE__Switch";}

◆ updateStateOnFinishedEventFrom()

YACS::Event Switch::updateStateOnFinishedEventFrom ( Node * node )

protectedvirtual

Implements YACS::ENGINE::ComposedNode.

Definition at line 642 of file Switch.cxx.

{
  setState(YACS::DONE);
  return YACS::FINISH;//notify to father node that 'this' has becomed finished.
}

References YACS::DONE, YACS::FINISH, and YACS::ENGINE::Node::setState().

◆ writeDot()

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

virtual

Dump to the input stream a dot representation of the node.

Parameters

os	: the input stream

Reimplemented from YACS::ENGINE::Node.

Definition at line 795 of file Switch.cxx.

{
  os << "  subgraph cluster_" << getId() << "  {\n" ;
  for(map<int,Node*>::const_iterator iter=_mapOfNode.begin();iter!=_mapOfNode.end();iter++)
    {
      Node* n=(*iter).second;
      n->writeDot(os);
      os << getId() << " -> " << n->getId() << ";\n";
    }
  os << "}\n" ;
  os << getId() << "[fillcolor=\"" ;
  YACS::StatesForNode state=Node::getEffectiveState();
  os << getColorState(state);
  os << "\" label=\"" << "Switch:" ;
  os << getQualifiedName() <<"\"];\n";
}

References _mapOfNode, YACS::ENGINE::Node::getColorState(), YACS::ENGINE::Node::getEffectiveState(), YACS::ENGINE::Node::getId(), YACS::ENGINE::Node::getQualifiedName(), gui.Appli::n, and yacsorb.CORBAEngineTest::state.

Friends And Related Function Documentation

◆ CollectorSwOutPort

friend class CollectorSwOutPort

friend

Definition at line 87 of file Switch.hxx.

Referenced by buildDelegateOf(), and Switch().

◆ FakeNodeForSwitch

friend class FakeNodeForSwitch

friend

Definition at line 86 of file Switch.hxx.

Referenced by exUpdateState().

Member Data Documentation

◆ _alreadyExistingCollectors

std::vector<CollectorSwOutPort *> YACS::ENGINE::Switch::_alreadyExistingCollectors

mutableprotected

Definition at line 97 of file Switch.hxx.

Referenced by getOutPort(), Switch(), and ~Switch().

◆ _condition

AnyInputPort YACS::ENGINE::Switch::_condition

protected

Definition at line 93 of file Switch.hxx.

Referenced by exUpdateState(), getAllInPortsComingFromOutsideOfCurrentScope(), getInputPort(), getLocalInputPorts(), getReadyTasks(), and getSetOfInputPort().

◆ _mapOfNode

std::map< int , Node * > YACS::ENGINE::Switch::_mapOfNode

protected

Definition at line 94 of file Switch.hxx.

Referenced by edChangeCase(), edGetDirectDescendants(), edGetNode(), edReleaseCase(), edRemoveChild(), edSetNode(), exUpdateState(), getCaseId(), getChildByShortName(), getMaxCase(), getMaxLevelOfParallelism(), getNbOfCases(), getRankOfNode(), getReadyTasks(), getWeightRegardingDPL(), init(), partitionRegardingDPL(), Switch(), writeDot(), and ~Switch().

◆ _outPortsCollector

std::map<InPort *, CollectorSwOutPort * > YACS::ENGINE::Switch::_outPortsCollector

protected

Definition at line 96 of file Switch.hxx.

Referenced by buildDelegateOf(), checkCFLinks(), getDelegateOf(), getOutPort(), releaseDelegateOf(), Switch(), and ~Switch().

◆ _undispatchableNotificationNode

FakeNodeForSwitch* YACS::ENGINE::Switch::_undispatchableNotificationNode

protected

Definition at line 95 of file Switch.hxx.

Referenced by exUpdateState(), getReadyTasks(), and ~Switch().

◆ DEFAULT_NODE_NAME

const char Switch::DEFAULT_NODE_NAME ="default"

static

Definition at line 89 of file Switch.hxx.

Referenced by getCaseId(), getChildByShortName(), and getRepresentationOfCase().

◆ ID_FOR_DEFAULT_NODE

const int Switch::ID_FOR_DEFAULT_NODE =-1973012217

static

Definition at line 91 of file Switch.hxx.

Referenced by YACS::ENGINE::VisitorSaveSchema::beginCase(), edReleaseDefaultNode(), edSetDefaultNode(), YACS::ENGINE::VisitorSaveSchema::endCase(), exUpdateState(), getCaseId(), getChildByShortName(), getReadyTasks(), getRepresentationOfCase(), and YACS::HMI::CaseSwitchEditor::GetStrValue().

◆ SELECTOR_INPUTPORT_NAME

const char Switch::SELECTOR_INPUTPORT_NAME ="select"

static

Definition at line 90 of file Switch.hxx.

Referenced by getInputPort().

The documentation for this class was generated from the following files:

src/engine/Switch.hxx
src/engine/Switch.cxx

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Switch() [1/2]

◆ Switch() [2/2]

◆ ~Switch()

Member Function Documentation

◆ accept()

◆ buildDelegateOf()

◆ checkCFLinks()

◆ checkControlDependancy()

◆ checkLinkPossibility()

◆ checkNoCyclePassingThrough()

◆ edAddChild()

◆ edChangeCase()

◆ edGetConditionPort()

◆ edGetDirectDescendants()

◆ edGetNode()

◆ edReleaseCase()

◆ edReleaseDefaultNode()

◆ edRemoveChild()

◆ edSetDefaultNode()

◆ edSetNode()

◆ exUpdateState()

◆ getAllInPortsComingFromOutsideOfCurrentScope()

◆ getCaseId()

◆ getChildByShortName()

◆ getDelegateOf()

◆ getEffectiveState() [1/2]

◆ getEffectiveState() [2/2]

◆ getInputPort()

◆ getLocalInputPorts()

◆ getMaxCase()

◆ getMaxLevelOfParallelism()

◆ getMyQualifiedName()

◆ getNbOfCases()

◆ getNumberOfInputPorts()

◆ getOutPort()

◆ getProgressWeight()

◆ getRankOfNode()

◆ getReadyTasks()

◆ getRepresentationOfCase()

◆ getSetOfInputPort()

◆ getWeightRegardingDPL()

◆ init()

◆ partitionRegardingDPL()

◆ releaseDelegateOf()

◆ simpleClone()

◆ typeName()

◆ updateStateOnFinishedEventFrom()

◆ writeDot()

Friends And Related Function Documentation

◆ CollectorSwOutPort

◆ FakeNodeForSwitch

Member Data Documentation

◆ _alreadyExistingCollectors

◆ _condition

◆ _mapOfNode

◆ _outPortsCollector

◆ _undispatchableNotificationNode

◆ DEFAULT_NODE_NAME

◆ ID_FOR_DEFAULT_NODE

◆ SELECTOR_INPUTPORT_NAME