#include <OptimizerLoop.hxx>

Inheritance diagram for YACS::ENGINE::FakeNodeForOptimizerLoop:

[legend]

Collaboration diagram for YACS::ENGINE::FakeNodeForOptimizerLoop:

[legend]

Private Member Functions
	FakeNodeForOptimizerLoop (OptimizerLoop *loop, bool normal, std::string message)

	FakeNodeForOptimizerLoop (const FakeNodeForOptimizerLoop &other)

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

void	exForwardFailed ()

void	exForwardFinished ()

void	execute ()

void	aborted ()

void	finished ()

Private Attributes
OptimizerLoop *	_loop

std::string	_message

bool	_normal

Static Private Attributes
static const char	NAME [] ="thisIsAFakeNode"

Friends
class	OptimizerLoop

Additional Inherited Members
Public Member Functions inherited from YACS::ENGINE::ElementaryNode
virtual	~ElementaryNode ()

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

void	init (bool start=true)

bool	isDeployable () const

ComponentInstance *	getComponent ()

const ComponentInstance *	getComponent () const

Container *	getContainer ()

YACS::StatesForNode	getState () const

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

void	edRemovePort (Port *port)

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

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

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

virtual void	checkBasicConsistency () const

ComposedNode *	getDynClonerIfExists (const ComposedNode *levelToStop) const

int	getNumberOfInputPorts () const

int	getNumberOfOutputPorts () const

std::string	getInPortName (const InPort *) const

std::string	getOutPortName (const OutPort *) const

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

OutputPort *	getOutputPort (const std::string &name) const

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

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

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

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

std::set< OutPort * >	getAllOutPortsLeavingCurrentScope () const

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

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

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

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

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

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

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

virtual InputPort *	createInputPort (const std::string &inputPortName, TypeCode *type)

virtual OutputPort *	createOutputPort (const std::string &outputPortName, TypeCode *type)

virtual InputDataStreamPort *	createInputDataStreamPort (const std::string &inputPortDSName, TypeCode *type)

virtual OutputDataStreamPort *	createOutputDataStreamPort (const std::string &outputPortDSName, TypeCode *type)

virtual InputPort *	edAddInputPort (const std::string &inputPortName, TypeCode *type)

virtual OutputPort *	edAddOutputPort (const std::string &outputPortName, TypeCode *type)

virtual InputDataStreamPort *	edAddInputDataStreamPort (const std::string &inputPortDSName, TypeCode *type)

virtual OutputDataStreamPort *	edAddOutputDataStreamPort (const std::string &outputPortDSName, TypeCode *type)

virtual void	edOrderInputPorts (const std::list< InputPort * > &ports)

virtual void	edOrderOutputPorts (const std::list< OutputPort * > &ports)

virtual std::string	typeName ()

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

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

int	getMaxLevelOfParallelism () const

ComplexWeight *	getWeight ()

void	setWeight (double elementaryWeight)

void	getWeightRegardingDPL (ComplexWeight *weight)

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

void	begin ()

bool	isReady ()

void	loaded ()
	Notify this node that it is loaded. More...

void	connected ()
	Notify this node that it is connected. More...

virtual std::string	getErrorDetails ()
	Give a description of error when node status is ERROR. More...

virtual void	initService ()

virtual void	connectService ()

virtual void	disconnectService ()

virtual void	load ()

virtual void	getCoupledTasks (std::set< Task * > &coupledSet)
	Calls getCoupledNodes for Task interface. More...

virtual void	getCoupledNodes (std::set< Task * > &coupledSet)
	Put all nodes that are coupled to this node in coupledSet. More...

void	accept (Visitor *visitor)

virtual void	addDatastreamPortToInitMultiService (const std::string &port_name, int number)

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

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

InPropertyPort *	getInPropertyPort () const

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

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 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	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	cleanNodes ()
	Clean the node in case of not clean exit. More...

Public Member Functions inherited from YACS::ENGINE::Task
virtual void	imposeResource (const std::string &resource_name, const std::string &container_name)

virtual bool	canAcceptImposedResource ()

virtual bool	hasImposedResource () const

virtual	~Task ()

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 Public Attributes inherited from YACS::ENGINE::Node
static std::map< int, Node * >	idMap

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

	ElementaryNode (const ElementaryNode &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	initCommonPartWithoutStateManagement (bool start)

virtual void	createMultiDatastreamPorts ()

void	edDisconnectAllLinksWithMe ()

bool	areAllInputPortsValid () const

template<class PORT >
PORT *	getPort (const std::string &name, const std::list< PORT * > &setOfPorts) const

template<class PORT , class ENUMTYPE >
PORT *	edAddPort (const std::string &portName, std::list< PORT * > &setOfPorts, ENUMTYPE type)

template<class PORT , class ENUMTYPE >
bool	edCheckAddPort (const std::string &portName, std::list< PORT * > &setOfPorts, ENUMTYPE type)

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

	Node (const Node &other, ComposedNode *father)

Static Protected Member Functions inherited from YACS::ENGINE::ElementaryNode
template<class PORT >
static void	edRemovePortTypedFromSet (PORT port, std::list< PORT > &setOfPorts)

template<class PORT >
static bool	isPortNameAlreadyExist (const std::string &portName, const std::list< PORT * > &setOfPorts)

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

static ComposedNode *	checkHavingCommonFather (Node node1, Node node2)

Protected Attributes inherited from YACS::ENGINE::ElementaryNode
std::list< InputPort * >	_setOfInputPort

std::list< OutputPort * >	_setOfOutputPort

std::list< InputDataStreamPort * >	_setOfInputDataStreamPort

std::list< OutputDataStreamPort * >	_setOfOutputDataStreamPort

ComplexWeight	_weight

bool	_createDatastreamPorts

bool	_multi_port_node

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

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

static int	_total = 0

Detailed Description

Definition at line 36 of file OptimizerLoop.hxx.

Constructor & Destructor Documentation

◆ FakeNodeForOptimizerLoop() [1/2]

FakeNodeForOptimizerLoop::FakeNodeForOptimizerLoop	(	OptimizerLoop *	loop,
		bool	normal,
		std::string	message
	)

private

Definition at line 42 of file OptimizerLoop.cxx.

   : ElementaryNode(NAME), _loop(loop), _normal(normal), _message(message)
 {
   _state=YACS::TOACTIVATE;
   _father=_loop->getFather();
 }

References YACS::ENGINE::Node::_father, _loop, YACS::ENGINE::Node::_state, YACS::ENGINE::Node::getFather(), and YACS::TOACTIVATE.

Referenced by simpleClone().

◆ FakeNodeForOptimizerLoop() [2/2]

FakeNodeForOptimizerLoop::FakeNodeForOptimizerLoop ( const FakeNodeForOptimizerLoop & other )

private

Definition at line 49 of file OptimizerLoop.cxx.

   : ElementaryNode(other), _loop(0), _normal(other._normal), _message(other._message)
 { 
 }

Member Function Documentation

◆ aborted()

void FakeNodeForOptimizerLoop::aborted ( )

privatevirtual

Reimplemented from YACS::ENGINE::ElementaryNode.

Definition at line 82 of file OptimizerLoop.cxx.

 {
   _loop->setState(YACS::ERROR);
 }

References _loop, YACS::ERROR, and YACS::ENGINE::Node::setState().

◆ execute()

void FakeNodeForOptimizerLoop::execute ( )

privatevirtual

Implements YACS::ENGINE::Task.

Definition at line 69 of file OptimizerLoop.cxx.

 {
   DEBTRACE("FakeNodeForOptimizerLoop::execute: " << _message)
   if (!_normal) {
     _loop->_errorDetails = _message;
     throw Exception(_message);
   }
   else
   {
     _loop->_algoResultPort.put(_loop->_alg->getAlgoResultProxy());
   }
 }

References YACS::ENGINE::OptimizerLoop::_alg, YACS::ENGINE::OptimizerLoop::_algoResultPort, YACS::ENGINE::Node::_errorDetails, _loop, _message, _normal, DEBTRACE, YACS::ENGINE::OptimizerAlgBase::getAlgoResultProxy(), and YACS::ENGINE::AnyOutputPort::put().

◆ exForwardFailed()

void FakeNodeForOptimizerLoop::exForwardFailed ( )

privatevirtual

Called typically by Bloc to notify failure on potentially next nodes on the same scope of 'this'

Reimplemented from YACS::ENGINE::Node.

Definition at line 59 of file OptimizerLoop.cxx.

 {
   _loop->exForwardFailed();
 }

References _loop, and YACS::ENGINE::Node::exForwardFailed().

◆ exForwardFinished()

void FakeNodeForOptimizerLoop::exForwardFinished ( )

privatevirtual

Called typically by Bloc to activate potentially next nodes on the same scope of 'this'

Reimplemented from YACS::ENGINE::Node.

Definition at line 64 of file OptimizerLoop.cxx.

 {
   _loop->exForwardFinished();
 }

References _loop, and YACS::ENGINE::Node::exForwardFinished().

◆ finished()

void FakeNodeForOptimizerLoop::finished ( )

privatevirtual

Reimplemented from YACS::ENGINE::ElementaryNode.

Definition at line 87 of file OptimizerLoop.cxx.

 {
   _loop->setState(YACS::DONE);
 }

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

◆ simpleClone()

Node * FakeNodeForOptimizerLoop::simpleClone	(	ComposedNode *	father,
		bool	editionOnly
	)		const

privatevirtual

Implements YACS::ENGINE::Node.

Definition at line 54 of file OptimizerLoop.cxx.

 {
   return new FakeNodeForOptimizerLoop(*this);
 }

References FakeNodeForOptimizerLoop().

Friends And Related Function Documentation

◆ OptimizerLoop

friend class OptimizerLoop

friend

Definition at line 38 of file OptimizerLoop.hxx.

Member Data Documentation

◆ _loop

OptimizerLoop* YACS::ENGINE::FakeNodeForOptimizerLoop::_loop

private

Definition at line 40 of file OptimizerLoop.hxx.

Referenced by aborted(), execute(), exForwardFailed(), exForwardFinished(), FakeNodeForOptimizerLoop(), and finished().

◆ _message

std::string YACS::ENGINE::FakeNodeForOptimizerLoop::_message

private

Definition at line 41 of file OptimizerLoop.hxx.

Referenced by execute().

◆ _normal

bool YACS::ENGINE::FakeNodeForOptimizerLoop::_normal

private

Definition at line 42 of file OptimizerLoop.hxx.

Referenced by execute().

◆ NAME

const char FakeNodeForOptimizerLoop::NAME ="thisIsAFakeNode"

staticprivate

Definition at line 53 of file OptimizerLoop.hxx.

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

src/engine/OptimizerLoop.hxx
src/engine/OptimizerLoop.cxx

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FakeNodeForOptimizerLoop() [1/2]

◆ FakeNodeForOptimizerLoop() [2/2]

Member Function Documentation

◆ aborted()

◆ execute()

◆ exForwardFailed()

◆ exForwardFinished()

◆ finished()

◆ simpleClone()

Friends And Related Function Documentation

◆ OptimizerLoop

Member Data Documentation

◆ _loop

◆ _message

◆ _normal

◆ NAME