YACS::ENGINE::Node Class Reference

Base class for all nodes. More...

#include <Node.hxx>

Inheritance diagram for YACS::ENGINE::Node:

Collaboration diagram for YACS::ENGINE::Node:

Public Member Functions
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...
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 throw (Exception)
virtual std::string	getOutPortName (const OutPort *) const =0 throw (Exception)
virtual std::list < InputDataStreamPort * >	getSetOfInputDataStreamPort () const =0
virtual std::list < OutputDataStreamPort * >	getSetOfOutputDataStreamPort () const =0
InPort *	getInPort (const std::string &name) const throw (Exception)
InPropertyPort *	getInPropertyPort () const throw (Exception)
virtual OutPort *	getOutPort (const std::string &name) const throw (Exception)
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 throw (Exception)
virtual OutputPort *	getOutputPort (const std::string &name) const =0 throw (Exception)
virtual InputDataStreamPort *	getInputDataStreamPort (const std::string &name) const =0 throw (Exception)
virtual OutputDataStreamPort *	getOutputDataStreamPort (const std::string &name) const =0 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 ComposedNode *	getRootNode () const throw (Exception)
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 throw (Exception)
virtual Proc *	getProc ()
virtual const Proc *	getProc () const
virtual void	accept (Visitor *visitor)=0
virtual int	getMaxLevelOfParallelism () const =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...

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

Public Attributes
YACS::Colour	_colour

Static Public Attributes
static std::map< int, Node * >	idMap

Protected Member Functions
	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 ()

Static Protected Member Functions
static void	checkValidityOfPortName (const std::string &name) throw (Exception)
static ComposedNode *	checkHavingCommonFather (Node *node1, Node *node2) throw (Exception)

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

Static Protected Attributes
static const char	SEP_CHAR_IN_PORT [] ="."
static int	_total = 0

Friends
class	Bloc
class	Loop
class	Switch
class	InputPort
class	OutputPort
class	InPropertyPort
class	DynParaLoop
class	ForEachLoop
class	ComposedNode
class	ElementaryNode
class	Visitor
void	StateLoader (Node *node, YACS::StatesForNode state)

Detailed Description

Base class for all nodes.

Definition at line 67 of file Node.hxx.

Constructor & Destructor Documentation

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

protected

Definition at line 68 of file Node.cxx.

References _inPropertyPort, _numId, YACS::ENGINE::Runtime::_tc_propvec, _total, idMap, and InPropertyPort.

                               :_name(name),_inGate(this),_outGate(this),_father(0),_state(YACS::READY),
                                    _implementation(Runtime::RUNTIME_ENGINE_INTERACTION_IMPL_NAME),_modified(1)
{
  // Should be protected by lock ??
  _numId = _total++;
  idMap[_numId]=this;

  // Every node has an InPropertyPort
  _inPropertyPort = new InPropertyPort("__InPropertyPort__Node__YACS_", this, Runtime::_tc_propvec);
}

Node::Node ( const Node &  other, ComposedNode *  father  )

protected

Definition at line 79 of file Node.cxx.

References _inPropertyPort, _numId, YACS::ENGINE::Runtime::_tc_propvec, _total, idMap, and InPropertyPort.

                                                 :_inGate(this),_outGate(this),_name(other._name),_father(father),
                                                   _state(YACS::READY),_implementation(other._implementation),
                                                    _propertyMap(other._propertyMap),_modified(1)
{
  _numId = _total++;
  idMap[_numId]=this;

  // Every node has an InPropertyPort
  _inPropertyPort = new InPropertyPort("__InPropertyPort__Node__YACS_", this, Runtime::_tc_propvec);
}

Node::~Node ( )

virtual

Definition at line 90 of file Node.cxx.

References _inPropertyPort.

{
  delete _inPropertyPort;
}

Member Function Documentation

virtual void YACS::ENGINE::Node::accept ( Visitor *  visitor )

pure virtual

Implemented in YACS::ENGINE::ForEachLoop, YACS::ENGINE::Loop, YACS::ENGINE::Switch, YACS::ENGINE::ElementaryNode, YACS::ENGINE::ComposedNode, YACS::ENGINE::DynParaLoop, YACS::ENGINE::InlineFuncNode, YACS::ENGINE::OptimizerLoop, YACS::ENGINE::Proc, YACS::ENGINE::InlineNode, YACS::ENGINE::Bloc, YACS::ENGINE::ServiceNode, YACS::ENGINE::StudyOutNode, YACS::ENGINE::ForLoop, YACS::ENGINE::WhileLoop, YACS::ENGINE::ServerNode, YACS::ENGINE::ServiceInlineNode, YACS::ENGINE::PresetNode, YACS::ENGINE::StudyInNode, and YACS::ENGINE::OutNode.

Referenced by YACS::ENGINE::VisitorSaveSchema::visitDynParaLoop().

void Node::applyDPLScope ( ComposedNode *  gfn )

virtual

Method called by the Executor only if the executor is sensitive of scope of DynParaLoop. This method is virtual and empty because by default nothing is done.

Reimplemented in YACS::ENGINE::PythonNode.

Definition at line 648 of file Node.cxx.

Referenced by YACS::ENGINE::Executor::functionForTaskExecution().

{
}

ComposedNode * Node::checkHavingCommonFather ( Node *  node1, Node *  node2  ) throw (Exception)

staticprotected

Note

: Check that 'node1' and 'node2' have exactly the same father

Exceptions

:	If 'node1' and 'node2' have NOT exactly the same father

Definition at line 439 of file Node.cxx.

References _father.

{
  if(node1!=0 && node2!=0)
    {
      if(node1->_father==node2->_father)
        return node1->_father;
    }
  throw Exception("check failed : nodes have not the same father");
}

void Node::checkValidityOfPortName ( const std::string &  name ) throw (Exception)

staticprotected

checks validity of ports name, that must not contain a particular character '?' USAGE NOT CLEAR, not used so far, when are those characters set ?

Definition at line 426 of file Node.cxx.

{
  if(name.find(SEP_CHAR_IN_PORT, 0 )!=string::npos)
    {
      string what("Port name "); what+=name; what+="not valid because it contains character "; what+=SEP_CHAR_IN_PORT;
      throw Exception(what);
    }
}

void Node::cleanNodes ( )

virtual

Clean the node in case of not clean exit.

This method should be called on a control-C or sigterm

Reimplemented in YACS::ENGINE::ComposedNode.

Definition at line 804 of file Node.cxx.

{
}

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

This method MUST NEVER BE VIRTUAL

This method clones this by :

• deep copying nodes, links, ports, types
• containers are either deep copied or shallow copied depending on _isAttachedOnCloning attribute.
• component are either deep copied or shallow copied depending on _isAttachedOnCloning attribute.

So this method clone is dedicated for DynParaLoop class or subclasses. It should not be used elsewhere, because _isAttachedOnCloning attribute is an attribute in the engine not for GUI/TUI aspects. For GUI/TUI manipulation cloneWithoutCompAndContDeepCpy method should be used preferably.

Parameters

[in]	father	- The new father of the returned clone.
[in]	editionOnly	ignored

See Also

cloneWithoutCompAndContDeepCpy

Definition at line 128 of file Node.cxx.

References performDuplicationOfPlacement(), PMMLBasicsTestLauncher::ret, and simpleClone().

Referenced by YACS::ENGINE::DynParaLoop::DynParaLoop(), YACS::ENGINE::ElementaryNode::getReadyTasks(), YACS::ENGINE::OptimizerLoop::initInterceptors(), YACS::ENGINE::ProcCataLoader::loadCata(), and YACS::HMI::CommandAddNodeFromCatalog::localExecute().

{
  Node *ret(simpleClone(father,editionOnly));
  ret->performDuplicationOfPlacement(*this);
  return ret;
}

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

This method MUST NEVER BE VIRTUAL

This method clones this by :

• deep copying nodes, links, ports, types
• shallow copy containers
• shallow copy components

So this method simply ignores isAttachedOnCloning attribute for both containers and components. So this method is dedicated for the GUI/TUI users.

Parameters

[in]	father	- The new father of the returned clone.
[in]	editionOnly	ignored

Definition at line 147 of file Node.cxx.

References performShallowDuplicationOfPlacement(), PMMLBasicsTestLauncher::ret, and simpleClone().

Referenced by YACS::HMI::CommandPutInComposedNode::localExecute(), YACS::HMI::CommandCopyNode::localExecute(), and YACS::HMI::SubjectNode::registerUndoDestroy().

{
  Node *ret(simpleClone(father,editionOnly));
  ret->performShallowDuplicationOfPlacement(*this);
  return ret;
}

bool Node::edAreAllInputPortInitialized ( ) const

virtual

Becomes deprecated soon. Replaced by ComposedNode::CheckConsistency.

Definition at line 365 of file Node.cxx.

References edGetSetOfUnitializedInputPort().

{
  set<InputPort *> setOfUnitializedInputPort = edGetSetOfUnitializedInputPort();
  return ( setOfUnitializedInputPort.size() == 0);
}

void Node::edDisconnectAllLinksWithMe ( )

protectedvirtual

Called typically by ComposedNode to correctly update DF/CF/DS links

Reimplemented in YACS::ENGINE::ElementaryNode, and YACS::ENGINE::ComposedNode.

Definition at line 391 of file Node.cxx.

References _inGate, _outGate, YACS::ENGINE::OutGate::edDisconnectAllLinksFromMe(), and YACS::ENGINE::InGate::edDisconnectAllLinksToMe().

Referenced by YACS::ENGINE::ComposedNode::edDisconnectAllLinksWithMe(), and YACS::ENGINE::ElementaryNode::edDisconnectAllLinksWithMe().

{
  _inGate.edDisconnectAllLinksToMe();
  _outGate.edDisconnectAllLinksFromMe();
}

set< InputPort * > Node::edGetSetOfUnitializedInputPort ( ) const

virtual

Becomes deprecated soon. Replaced by ComposedNode::CheckConsistency.

Definition at line 352 of file Node.cxx.

References getSetOfInputPort().

Referenced by edAreAllInputPortInitialized().

{
  set<InputPort *> setOfUnitializedInputPort;
  list<InputPort *> allOfInputPorts=getSetOfInputPort();
  for(list<InputPort *>::const_iterator iter=allOfInputPorts.begin();iter!=allOfInputPorts.end();iter++)
    {
      if ( ! (*iter)->edIsInitialized() )
        setOfUnitializedInputPort.insert(*iter);
    }
  return setOfUnitializedInputPort;
}

void Node::edUpdateState ( )

virtual

update the status of the node

Only useful when editing a schema Do nothing in base Node : to implement in derived classes

Reimplemented in YACS::ENGINE::ComposedNode, and YACS::ENGINE::ElementaryNode.

Definition at line 703 of file Node.cxx.

References _modified, and DEBTRACE.

Referenced by isValid().

{
  DEBTRACE("Node::edUpdateState(): " << _modified);
  _modified=0;
}

void Node::ensureLoading ( )

virtual

Put this node into TOLOAD state when possible.

Reimplemented in YACS::ENGINE::ElementaryNode.

Definition at line 775 of file Node.cxx.

References _state, YACS::READY, setState(), and YACS::TOLOAD.

Referenced by YACS::ENGINE::ElementaryNode::ensureLoading().

{
  if(_state == YACS::READY)
    setState(YACS::TOLOAD);
}

void Node::exDisabledState ( )

virtual

Notify this node that it has been disabled.

The node goes in DISABLED state and propagate the notification through the outGate port

Definition at line 228 of file Node.cxx.

References _outGate, DEBTRACE, YACS::DISABLED, YACS::ENGINE::OutGate::exNotifyDisabled(), getName(), and setState().

Referenced by YACS::ENGINE::InGate::exNotifyDisabled(), YACS::ENGINE::ElementaryNode::init(), init(), YACS::ENGINE::PyFuncNode::init(), and YACS::switchtypeParser::state().

{
  DEBTRACE( "Node::exDisabledState: " << getName() );
  setState(YACS::DISABLED);
  _outGate.exNotifyDisabled();
}

void Node::exFailedState ( )

virtual

Notify this node that its execution has failed.

The node goes in FAILED state and propagate the notification through the outGate port

Definition at line 215 of file Node.cxx.

References _outGate, DEBTRACE, YACS::ENGINE::OutGate::exNotifyFailed(), YACS::FAILED, getName(), and setState().

Referenced by YACS::ENGINE::InGate::exNotifyFailed().

{
  DEBTRACE( "Node::exFailedState: " << getName() );
  setState(YACS::FAILED);
  _outGate.exNotifyFailed();
}

void Node::exForwardFailed ( )

protectedvirtual

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

Reimplemented in YACS::ENGINE::FakeNodeForLoop, YACS::ENGINE::FakeNodeForForEachLoop, YACS::ENGINE::FakeNodeForSwitch, and YACS::ENGINE::FakeNodeForOptimizerLoop.

Definition at line 374 of file Node.cxx.

References _outGate, and YACS::ENGINE::OutGate::exNotifyFailed().

Referenced by YACS::ENGINE::FakeNodeForOptimizerLoop::exForwardFailed(), YACS::ENGINE::FakeNodeForSwitch::exForwardFailed(), YACS::ENGINE::FakeNodeForForEachLoop::exForwardFailed(), YACS::ENGINE::FakeNodeForLoop::exForwardFailed(), YACS::ENGINE::ForEachLoop::exUpdateState(), YACS::ENGINE::ForEachLoop::updateStateForWorkNodeOnFinishedEventFrom(), YACS::ENGINE::ComposedNode::updateStateFrom(), YACS::ENGINE::Bloc::updateStateOnFailedEventFrom(), YACS::ENGINE::Bloc::updateStateOnFinishedEventFrom(), and YACS::ENGINE::OptimizerLoop::updateStateOnFinishedEventFrom().

{
  _outGate.exNotifyFailed();
}

void Node::exForwardFinished ( )

protectedvirtual

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

Reimplemented in YACS::ENGINE::FakeNodeForLoop, YACS::ENGINE::FakeNodeForForEachLoop, YACS::ENGINE::FakeNodeForSwitch, and YACS::ENGINE::FakeNodeForOptimizerLoop.

Definition at line 382 of file Node.cxx.

References _outGate, DEBTRACE, and YACS::ENGINE::OutGate::exNotifyDone().

Referenced by YACS::ENGINE::FakeNodeForOptimizerLoop::exForwardFinished(), YACS::ENGINE::FakeNodeForSwitch::exForwardFinished(), YACS::ENGINE::FakeNodeForForEachLoop::exForwardFinished(), YACS::ENGINE::FakeNodeForLoop::exForwardFinished(), and YACS::ENGINE::Bloc::updateStateOnFinishedEventFrom().

{
  DEBTRACE("Node::exForwardFinished");
  _outGate.exNotifyDone();
}

bool Node::exIsControlReady

(

)

const

Definition at line 190 of file Node.cxx.

References _inGate, and YACS::ENGINE::InGate::exIsReady().

{
  return _inGate.exIsReady();
}

void Node::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 in YACS::ENGINE::ForEachLoop, YACS::ENGINE::Switch, YACS::ENGINE::OptimizerLoop, YACS::ENGINE::ElementaryNode, YACS::ENGINE::Bloc, YACS::ENGINE::WhileLoop, and YACS::ENGINE::ForLoop.

Definition at line 202 of file Node.cxx.

References _inGate, _state, YACS::DISABLED, YACS::ENGINE::InGate::exIsReady(), setState(), and YACS::TOACTIVATE.

Referenced by YACS::ENGINE::InGate::exNotifyFromPrecursor(), YACS::ENGINE::ForLoop::exUpdateState(), YACS::ENGINE::WhileLoop::exUpdateState(), YACS::ENGINE::ForEachLoop::updateStateForWorkNodeOnFinishedEventFrom(), YACS::ENGINE::WhileLoop::updateStateOnFinishedEventFrom(), and YACS::ENGINE::ForLoop::updateStateOnFinishedEventFrom().

{
  if(_state==YACS::DISABLED)return;
  if(_inGate.exIsReady())
    setState(YACS::TOACTIVATE);
}

std::list< ComposedNode * > Node::getAllAscendanceOf

(

ComposedNode *

levelToStop = 0

)

const

gets a set of the composed nodes that constitute the ascendancy of this node, starting from root or from a particular ancestor WARNING : returned set is not sorted !

Parameters

levelToStop

composed node which is the oldest ancestor required

Returns

ascendancy, direct father first in set.

Definition at line 313 of file Node.cxx.

References _father, and PMMLBasicsTestLauncher::ret.

Referenced by YACS::ENGINE::OutPort::calculateHistoryOfLinkWith(), YACS::ENGINE::ComposedNode::edAddLink(), and YACS::ENGINE::ComposedNode::isNodeAlreadyAggregated().

{
  list<ComposedNode *> ret;
  if(this==levelToStop)
    return ret;
  for(ComposedNode *iter=_father;iter!=levelToStop && iter!=0; iter=iter->_father)
      ret.push_back(iter);
  return ret;
}

virtual std::set<InPort *> YACS::ENGINE::Node::getAllInPortsComingFromOutsideOfCurrentScope ( ) const

pure virtual

Implemented in YACS::ENGINE::Switch, YACS::ENGINE::ComposedNode, and YACS::ENGINE::ElementaryNode.

virtual std::set<OutPort *> YACS::ENGINE::Node::getAllOutPortsLeavingCurrentScope ( ) const

pure virtual

Implemented in YACS::ENGINE::ComposedNode, and YACS::ENGINE::ElementaryNode.

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

pure virtual

Implemented in YACS::ENGINE::ComposedNode, and YACS::ENGINE::ElementaryNode.

Referenced by YACS::ENGINE::ComposedNode::getChildByName(), YACS::HMI::SubjectComposedNode::loadChildren(), YACS::ENGINE::graphParser::onEnd(), YACS::ENGINE::nodeParser::onEnd(), YACS::ENGINE::portParser::onEnd(), and YACS::ENGINE::VisitorSaveSchema::writeSimpleDataLinks().

std::string Node::getColorState

(

YACS::StatesForNode

state

)

const

Return the color associated to a state.

Parameters

state

: the node state

Returns

the associated color

Definition at line 549 of file Node.cxx.

References YACS::ACTIVATED, YACS::DISABLED, YACS::DONE, YACS::ERROR, YACS::FAILED, YACS::LOADED, YACS::PAUSE, YACS::READY, YACS::TOACTIVATE, and YACS::TOLOAD.

Referenced by YACS::ENGINE::Bloc::writeDot(), writeDot(), YACS::ENGINE::Loop::writeDot(), and YACS::ENGINE::ForEachLoop::writeDot().

{
  switch(state)
    {
    case YACS::READY:
      return "pink";
    case YACS::TOLOAD:
      return "magenta";
    case YACS::LOADED:
      return "magenta";
    case YACS::TOACTIVATE:
      return "purple";
    case YACS::ACTIVATED:
      return "blue";
    case YACS::DONE:
      return "green";
    case YACS::ERROR:
      return "red";
    case YACS::FAILED:
      return "orange";
    case YACS::DISABLED:
      return "grey";
    case YACS::PAUSE:
      return "white";
    default:
      return "white";
    }
}

std::string Node::getContainerLog ( )

virtual

returns a string that contains the name of the container log file if it exists

Do nothing here. To subclass

Reimplemented in YACS::ENGINE::PyFuncNode, YACS::ENGINE::SalomeNode, and YACS::ENGINE::PythonNode.

Definition at line 754 of file Node.cxx.

Referenced by YACS::ENGINE::Proc::getNodeContainerLog().

{
  return "";
}

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

inlinevirtual

Reimplemented in YACS::ENGINE::ElementaryNode.

Definition at line 192 of file Node.hxx.

Referenced by YACS::ENGINE::ElementaryNode::getCoupledNodes().

{ }

std::vector< std::pair< std::string, int > > Node::getDPLScopeInfo

(

ComposedNode *

gfn

)

Definition at line 625 of file Node.cxx.

References YACS::ENGINE::DynParaLoop::getBranchIDOfNode(), YACS::ENGINE::ComposedNode::getChildName(), getFather(), p, and PMMLBasicsTestLauncher::ret.

Referenced by YACS::ENGINE::PythonNode::applyDPLScope().

{ 
  std::vector< std::pair<std::string,int> > ret;
  Node *work2(this);
  ComposedNode *work(getFather());
  while(work!=gfn && work!=0)
    {
      DynParaLoop *workc(dynamic_cast<DynParaLoop *>(work));
      if(workc)
        {
          std::pair<std::string,int> p(gfn->getChildName(workc),workc->getBranchIDOfNode(work2));
          ret.push_back(p);
        }
      work2=work;
      work=work->getFather();
    }
  return ret;
}

YACS::StatesForNode Node::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 in YACS::ENGINE::Switch.

Definition at line 509 of file Node.cxx.

References _father, _state, YACS::DISABLED, and getEffectiveState().

Referenced by dumpState(), getEffectiveState(), YACS::ENGINE::DynParaLoop::getErrorReport(), YACS::ENGINE::ComposedNode::getErrorReport(), getErrorReport(), YACS::ENGINE::Proc::getNodeState(), Proc_i::getState(), YACS::ENGINE::Proc::getXMLState(), Proc_i::getXMLState(), main(), YACS::ENGINE::Bloc::writeDot(), writeDot(), YACS::ENGINE::Loop::writeDot(), and YACS::ENGINE::ForEachLoop::writeDot().

{
  if(!_father)   //the root node
    return _state;
  if(_state==YACS::DISABLED)
    return YACS::DISABLED;
  return _father->getEffectiveState(this);
}

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

virtual

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

Parameters

node,:

the node which effective state is queried

Returns

the effective node state

Reimplemented in YACS::ENGINE::Switch.

Definition at line 523 of file Node.cxx.

References YACS::DISABLED, YACS::ERROR, YACS::FAILED, getEffectiveState(), getState(), YACS::READY, and YACS::TOACTIVATE.

{
  if(node->getState()==YACS::DISABLED)
    return YACS::DISABLED;

  YACS::StatesForNode effectiveState=getEffectiveState();
  switch(effectiveState)
    {
    case YACS::READY:
      return YACS::READY;
    case YACS::TOACTIVATE:
      return YACS::READY;
    case YACS::DISABLED:
      return YACS::DISABLED;
    case YACS::ERROR:
      return YACS::FAILED;
    default:
      return node->getState();
    }
}

virtual std::string YACS::ENGINE::Node::getErrorDetails ( ) const

inlinevirtual

Definition at line 183 of file Node.hxx.

Referenced by YACS::ENGINE::DynParaLoop::forwardExecStateToOriginalBody(), YACS::ENGINE::Proc::getNodeErrorDetails(), and YACS::HMI::GenericGui::onGetErrorDetails().

{ return _errorDetails; }

std::string Node::getErrorReport ( )

virtual

returns a string that contains an error report if the node is in error

Reimplemented in YACS::ENGINE::ComposedNode, and YACS::ENGINE::DynParaLoop.

Definition at line 713 of file Node.cxx.

References _errorDetails, DEBTRACE, YACS::DISABLED, YACS::ERROR, YACS::FAILED, getEffectiveState(), getName(), getState(), YACS::INTERNALERR, and YACS::INVALID.

Referenced by YACS::ENGINE::Proc::getNodeErrorReport(), YACS::HMI::GenericGui::onGetErrorReport(), and YACS::ENGINE::OptimizerLoop::updateStateOnFailedEventFrom().

{
  if(getState()==YACS::DISABLED)
    return "<error node= "+getName()+ "state= DISABLED/>\n";

  YACS::StatesForNode effectiveState=getEffectiveState();

  DEBTRACE("Node::getErrorReport: " << getName() << " " << effectiveState << " " << _errorDetails);
  if(effectiveState != YACS::INVALID &&  effectiveState != YACS::ERROR && 
     effectiveState != YACS::FAILED && effectiveState != YACS::INTERNALERR)
    return "";

  std::string report="<error node= " ;
  report=report + getName() ;
  switch(effectiveState)
    {
    case YACS::INVALID:
      report=report+" state= INVALID";
      break;
    case YACS::ERROR:
      report=report+" state= ERROR";
      break;
    case YACS::FAILED:
      report=report+" state= FAILED";
      break;
    case YACS::INTERNALERR:
      report=report+" state= INTERNALERR";
      break;
    default:
      break;
    }
  report=report + ">\n" ;
  report=report+_errorDetails;
  report=report+"\n</error>";
  return report;
}

ComposedNode* YACS::ENGINE::Node::getFather ( ) const

inline

Definition at line 124 of file Node.hxx.

Referenced by YACS::ENGINE::VisitorSaveSchema::beginCase(), YACS::ENGINE::OutPort::calculateHistoryOfLinkWith(), YACS::ENGINE::VisitorSaveSchema::depthNode(), YACS::ENGINE::ComposedNode::edAddDFLink(), YACS::ENGINE::VisitorSaveSchema::endCase(), YACS::ENGINE::FakeNodeForForEachLoop::FakeNodeForForEachLoop(), YACS::ENGINE::FakeNodeForLoop::FakeNodeForLoop(), YACS::ENGINE::FakeNodeForOptimizerLoop::FakeNodeForOptimizerLoop(), YACS::ENGINE::FakeNodeForSwitch::FakeNodeForSwitch(), getDPLScopeInfo(), YACS::ENGINE::ForEachLoop::getFEDeltaBetween(), YACS::HMI::SubjectComposedNode::getLowestCommonAncestor(), YACS::HMI::SceneBlocItem::getNodesInfo(), YACS::HMI::CommandReparentNode::localExecute(), YACS::HMI::CommandPutInComposedNode::localExecute(), YACS::HMI::CommandCopyNode::localExecute(), YACS::HMI::CommandAddLink::localExecute(), YACS::HMI::CommandAddControlLink::localExecute(), YACS::HMI::CommandReparentNode::localReverse(), YACS::HMI::CommandPutInComposedNode::localReverse(), YACS::HMI::GuiEditor::PutSubjectInBloc(), YACS::HMI::SubjectNode::registerUndoDestroy(), YACS::HMI::SubjectNode::restoreLinks(), YACS::HMI::SubjectNode::saveLinks(), YACS::HMI::SubjectControlLink::SubjectControlLink(), YACS::HMI::SubjectLink::SubjectLink(), YACS::ENGINE::VisitorSaveSchema::writeControls(), YACS::ENGINE::VisitorSaveSchema::writeSimpleDataLinks(), and YACS::HMI::SubjectNode::~SubjectNode().

{ return _father; }

const std::string Node::getId

(

)

const

Definition at line 449 of file Node.cxx.

References YACS::ENGINE::ComposedNode::getChildName(), YACS::ENGINE::ComposedNode::getName(), and getRootNode().

Referenced by YACS::ENGINE::Bloc::writeDot(), YACS::ENGINE::Switch::writeDot(), writeDot(), YACS::ENGINE::Loop::writeDot(), and YACS::ENGINE::ForEachLoop::writeDot().

{
    std::string id=getRootNode()->getName();
    if(getRootNode() != this)
      id= id+'.'+ getRootNode()->getChildName(this);
    string::size_type debut =id.find_first_of('.');
    while(debut != std::string::npos){
        id[debut]='_';
        debut=id.find_first_of('.',debut);
    }
    return id;
}

string Node::getImplementation

(

)

const

Returns

Implementation of node: C++, Python, CORBA... _implementation is set by a derived class in a Runtime it normally applies only to elementaryNodes and it is used by Ports to select Data Converters. Potential problem with Ports attached to composed Nodes...

Definition at line 346 of file Node.cxx.

References _implementation.

Referenced by writeDot().

{
  return _implementation;
}

InGate* YACS::ENGINE::Node::getInGate ( )

inline

Definition at line 120 of file Node.hxx.

Referenced by YACS::ENGINE::Loop::buildDelegateOf(), YACS::ENGINE::CFDirectionVisTraits< false >::getNexts(), YACS::ENGINE::BlocPoint::getNodeB4(), YACS::ENGINE::AbstractPoint::GetNodeB4(), YACS::ENGINE::ElementaryNode::getReadyTasks(), YACS::ENGINE::AbstractPoint::isBegin(), YACS::ENGINE::AbstractPoint::IsGatherB4Ext(), YACS::ENGINE::AbstractPoint::IsNoLinksBefore(), YACS::ENGINE::AbstractPoint::isSimplyLinkedBefore(), YACS::ENGINE::AbstractPoint::IsSimplyLinkedBeforeExt(), YACS::HMI::CommandAddLink::localExecute(), YACS::ENGINE::graphParser::onEnd(), resetState(), YACS::HMI::SubjectNode::restoreLinks(), and YACS::HMI::SubjectNode::saveLinks().

{ return &_inGate; }

InPort * Node::getInPort

(

const std::string &

name

)

const throw (Exception)

Definition at line 235 of file Node.cxx.

References PMMLBasicsTestLauncher::ret.

Referenced by YACS::ENGINE::Bloc::Bloc(), YACS::ENGINE::DynParaLoop::cloneAndPlaceNodesCoherently(), YACS::ENGINE::DynParaLoop::DynParaLoop(), YACS::ENGINE::ForLoop::ForLoop(), and YACS::ENGINE::WhileLoop::WhileLoop().

{
  InPort *ret;
  try
    {
      ret=getInputPort(name);
    }
  catch(Exception& e)
    {
      ret=getInputDataStreamPort(name);
    }
  return ret;
}

virtual std::string YACS::ENGINE::Node::getInPortName ( const InPort *  ) const throw (Exception)

pure virtual

Implemented in YACS::ENGINE::ComposedNode, and YACS::ENGINE::ElementaryNode.

InPropertyPort * Node::getInPropertyPort

(

)

const throw (Exception)

Definition at line 250 of file Node.cxx.

References _inPropertyPort.

{
  return _inPropertyPort;
}

virtual InputDataStreamPort* YACS::ENGINE::Node::getInputDataStreamPort ( const std::string &  name ) const throw (Exception)

pure virtual

Implemented in YACS::ENGINE::DSToDFForLoop, YACS::ENGINE::ComposedNode, and YACS::ENGINE::ElementaryNode.

Referenced by YACS::ENGINE::OutputPort4DS2DF::getAllRepresented(), YACS::ENGINE::ComposedNode::getInputDataStreamPort(), YACS::HMI::CommandRenameInDataPort::localExecute(), YACS::HMI::CommandAddLink::localExecute(), YACS::HMI::CommandSetDSPortProperties::localExecute(), YACS::HMI::CommandSetLinkProperties::localExecute(), YACS::HMI::CommandDestroy::localExecute(), YACS::HMI::CommandRenameInDataPort::localReverse(), YACS::HMI::CommandAddLink::localReverse(), YACS::HMI::CommandSetDSPortProperties::localReverse(), and YACS::HMI::CommandSetLinkProperties::localReverse().

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

virtual

Reimplemented in YACS::ENGINE::ForEachLoop, YACS::ENGINE::Switch, YACS::ENGINE::ComposedNode, YACS::ENGINE::SplitterNode, YACS::ENGINE::OptimizerLoop, YACS::ENGINE::DynParaLoop, YACS::ENGINE::ElementaryNode, YACS::ENGINE::DFToDSForLoop, YACS::ENGINE::WhileLoop, and YACS::ENGINE::ForLoop.

Definition at line 256 of file Node.cxx.

Referenced by YACS::HMI::GuiEditor::CreateInputPort(), YACS::ENGINE::Proc::getInPortValue(), YACS::ENGINE::DFToDSForLoop::getInputPort(), YACS::ENGINE::ElementaryNode::getInputPort(), YACS::ENGINE::ComposedNode::getInputPort(), YACS::HMI::CommandRenameInDataPort::localExecute(), YACS::HMI::CommandSetInPortValue::localExecute(), YACS::HMI::CommandSetForEachBranch::localExecute(), YACS::HMI::CommandAddLink::localExecute(), YACS::HMI::CommandDestroy::localExecute(), YACS::HMI::CommandRenameInDataPort::localReverse(), YACS::HMI::CommandSetInPortValue::localReverse(), YACS::HMI::CommandSetForEachBranch::localReverse(), YACS::HMI::CommandAddLink::localReverse(), YACS::ENGINE::Proc::setInPortValue(), and YACS::HMI::EditionForEachLoop::update().

{
  if (name == "__InPropertyPort__Node__YACS_")
    return _inPropertyPort;
  else
  {
    std::string what("Node::getInputPort : the port with name "); what+=name; what+=" does not exist on the current level";
    throw Exception(what);
  }
}

virtual std::list<InputPort *> YACS::ENGINE::Node::getLocalInputPorts ( ) const

pure virtual

Implemented in YACS::ENGINE::ForEachLoop, YACS::ENGINE::Switch, YACS::ENGINE::DynParaLoop, YACS::ENGINE::ComposedNode, YACS::ENGINE::OptimizerLoop, YACS::ENGINE::ElementaryNode, YACS::ENGINE::ForLoop, and YACS::ENGINE::WhileLoop.

Referenced by YACS::HMI::GuiExecutor::event(), YACS::HMI::GuiExecutor::updateSchema(), and YACS::ENGINE::VisitorSaveSchema::writeParametersNode().

virtual std::list<OutputPort *> YACS::ENGINE::Node::getLocalOutputPorts ( ) const

pure virtual

Implemented in YACS::ENGINE::ForEachLoop, YACS::ENGINE::OptimizerLoop, YACS::ENGINE::ComposedNode, YACS::ENGINE::ElementaryNode, YACS::ENGINE::DynParaLoop, and YACS::ENGINE::ForLoop.

Referenced by YACS::HMI::GuiExecutor::event(), YACS::HMI::GuiExecutor::updateSchema(), and YACS::ENGINE::VisitorSaveSchema::writeSimpleDataLinks().

virtual int YACS::ENGINE::Node::getMaxLevelOfParallelism ( ) const

pure virtual

Implemented in YACS::ENGINE::Loop, YACS::ENGINE::Switch, YACS::ENGINE::ElementaryNode, YACS::ENGINE::DynParaLoop, YACS::ENGINE::InlineNode, and YACS::ENGINE::Bloc.

Referenced by YACS::ENGINE::ElementaryPoint::getMaxLevelOfParallelism(), YACS::ENGINE::DynParaLoop::getMaxLevelOfParallelism(), and YACS::ENGINE::Loop::getMaxLevelOfParallelism().

const std::string& YACS::ENGINE::Node::getName ( ) const

inline

Definition at line 122 of file Node.hxx.

Referenced by YACS::ENGINE::CollectorSwOutPort::addPotentialProducerForMaster(), YACS::HMI::SubjectComposedNode::addSubjectNode(), YACS::ENGINE::OutNode::checkBasicConsistency(), YACS::ENGINE::StudyInNode::checkBasicConsistency(), YACS::ENGINE::PresetNode::checkBasicConsistency(), YACS::ENGINE::StudyOutNode::checkBasicConsistency(), YACS::ENGINE::InputPort::checkBasicConsistency(), YACS::ENGINE::PythonNode::checkBasicConsistency(), YACS::ENGINE::PyFuncNode::checkBasicConsistency(), YACS::ENGINE::DynParaLoop::checkConsistencyAndSetNode(), YACS::ENGINE::DynParaLoop::cloneAndPlaceNodesCoherently(), YACS::ENGINE::PythonEntry::commonRemoteLoadPart1(), YACS::HMI::SubjectNode::copy(), YACS::ENGINE::PythonNode::createRemoteAdaptedPyInterpretor(), YACS::ENGINE::PyFuncNode::createRemoteAdaptedPyInterpretor(), YACS::ENGINE::ComposedNode::edAddDFLink(), YACS::ENGINE::Loop::edSetNode(), YACS::ENGINE::ElementaryNode::edUpdateState(), YACS::ENGINE::ElementaryNode::ensureLoading(), exDisabledState(), YACS::ENGINE::SalomePythonNode::execute(), YACS::ENGINE::CORBANode::execute(), YACS::ENGINE::DistributedPythonNode::execute(), YACS::ENGINE::SalomeNode::execute(), YACS::ENGINE::PythonNode::executeLocal(), YACS::ENGINE::PyFuncNode::executeLocal(), YACS::ENGINE::PythonNode::executeRemote(), YACS::ENGINE::PyFuncNode::executeRemote(), exFailedState(), YACS::ENGINE::ElementaryNode::exUpdateState(), YACS::dynparalooptypeParser< T >::finalizenode(), getErrorReport(), YACS::ENGINE::CollectorSwOutPort::getHumanReprOfIncompleteCases(), YACS::ENGINE::ElementaryNode::getInPortName(), YACS::ENGINE::ComposedNode::getMyQualifiedName(), YACS::ENGINE::Switch::getMyQualifiedName(), YACS::ENGINE::ComposedNode::getName(), YACS::HMI::SubjectNode::getName(), YACS::ENGINE::ElementaryNode::getOutPortName(), YACS::ENGINE::ComposedNode::getPortName(), getQualifiedName(), YACS::ENGINE::ElementaryNode::getReadyTasks(), YACS::ENGINE::ElementaryPoint::getRepr(), YACS::ENGINE::ElementaryNode::init(), YACS::dynparalooptypeParser< T >::initnode(), YACS::looptypeParser< T >::inline_(), YACS::casetypeParser::inline_(), YACS::bloctypeParser< T >::inline_(), YACS::ENGINE::DistributedPythonNode::load(), YACS::HMI::SubjectComposedNode::loadLinks(), YACS::ENGINE::PyFuncNode::loadLocal(), YACS::HMI::CommandReparentNode::localExecute(), YACS::HMI::CommandCopyNode::localExecute(), YACS::HMI::CommandRenameNode::localExecute(), YACS::HMI::CommandRenameNode::localReverse(), modified(), YACS::looptypeParser< T >::node(), YACS::casetypeParser::node(), YACS::bloctypeParser< T >::node(), YACS::HMI::SubjectNode::notifyObserver(), YACS::ENGINE::graphParser::onEnd(), YACS::bloctypeParser< T >::outnode(), YACS::bloctypeParser< T >::preset(), YACS::looptypeParser< T >::remote(), YACS::casetypeParser::remote(), YACS::bloctypeParser< T >::remote(), YACS::HMI::SubjectComposedNode::removeControlLink(), YACS::HMI::SubjectNode::reparent(), resetState(), YACS::ENGINE::PythonNode::retrieveDftRemotePyInterpretorIfAny(), YACS::ENGINE::PyFuncNode::retrieveDftRemotePyInterpretorIfAny(), YACS::HMI::SubjectNode::saveLinks(), YACS::looptypeParser< T >::server(), YACS::casetypeParser::server(), YACS::bloctypeParser< T >::server(), YACS::looptypeParser< T >::service(), YACS::casetypeParser::service(), YACS::bloctypeParser< T >::service(), YACS::HMI::GuiExecutor::setInPortValue(), YACS::HMI::SubjectDataPort::setName(), YACS::HMI::SubjectNode::setName(), setState(), YACS::looptypeParser< T >::sinline(), YACS::casetypeParser::sinline(), YACS::bloctypeParser< T >::sinline(), YACS::ENGINE::ComposedNode::updateStateFrom(), YACS::ENGINE::OptimizerLoop::updateStateOnFailedEventFrom(), YACS::ENGINE::DynParaLoop::updateStateOnFailedEventFrom(), YACS::ENGINE::ForLoop::updateStateOnFinishedEventFrom(), YACS::ENGINE::Bloc::updateStateOnFinishedEventFrom(), YACS::ENGINE::ForEachLoop::updateStateOnFinishedEventFrom(), YACS::ENGINE::VisitorSaveSchema::visitInlineFuncNode(), YACS::ENGINE::VisitorSaveSchema::visitInlineNode(), YACS::ENGINE::VisitorSaveSalomeSchema::visitOutNode(), YACS::ENGINE::VisitorSaveSalomeSchema::visitPresetNode(), YACS::ENGINE::VisitorSaveSchema::visitServerNode(), YACS::ENGINE::VisitorSaveSchema::visitServiceInlineNode(), YACS::ENGINE::VisitorSaveSchema::visitServiceNode(), YACS::ENGINE::VisitorSaveSalomeSchema::visitStudyInNode(), YACS::ENGINE::VisitorSaveSalomeSchema::visitStudyOutNode(), YACS::ENGINE::VisitorSaveSchema::writeSimpleDataLinks(), and YACS::ENGINE::VisitorSaveSchema::writeSimpleStreamLinks().

{ return _name; }

virtual int YACS::ENGINE::Node::getNumberOfInputPorts ( ) const

pure virtual

Implemented in YACS::ENGINE::ForEachLoop, YACS::ENGINE::Loop, YACS::ENGINE::Switch, YACS::ENGINE::ComposedNode, YACS::ENGINE::OptimizerLoop, YACS::ENGINE::DynParaLoop, and YACS::ENGINE::ElementaryNode.

virtual int YACS::ENGINE::Node::getNumberOfOutputPorts ( ) const

pure virtual

Implemented in YACS::ENGINE::OptimizerLoop, YACS::ENGINE::ComposedNode, YACS::ENGINE::DynParaLoop, and YACS::ENGINE::ElementaryNode.

int Node::getNumId

(

)

return node instance identifiant, unique for each node instance

node instance identifiant is used to check if to nodes pointers refers to the same instance

Definition at line 608 of file Node.cxx.

References _numId.

Referenced by YACS::HMI::SubjectComposedNode::addSubjectNode(), YACS::ENGINE::VisitorSaveSchema::depthNode(), YACS::ENGINE::SALOMEDispatcher::dispatch(), MyDispatcher::dispatch(), YACS::HMI::GuiExecutor::getContainerLog(), YACS::HMI::GuiExecutor::getErrorDetails(), YACS::HMI::GuiExecutor::getErrorReport(), YACS::ENGINE::Proc::getNumIds(), YACS::HMI::GuiObserver_i::setConversion(), YACS::ENGINE::VisitorSaveSchema::writeControls(), YACS::ENGINE::VisitorSaveSchema::writeSimpleDataLinks(), and YACS::ENGINE::VisitorSaveSchema::writeSimpleStreamLinks().

{
  return _numId;
}

OutGate* YACS::ENGINE::Node::getOutGate ( )

inline

Definition at line 121 of file Node.hxx.

Referenced by YACS::ENGINE::Loop::buildDelegateOf(), YACS::ENGINE::CFDirectionVisTraits< true >::getNexts(), YACS::ENGINE::BlocPoint::getNodeAfter(), YACS::ENGINE::AbstractPoint::GetNodeAfter(), YACS::HMI::SceneBlocItem::getNodesInfo(), YACS::ENGINE::AbstractPoint::isLast(), YACS::ENGINE::AbstractPoint::IsNoLinksAfter(), YACS::ENGINE::AbstractPoint::IsScatterAfterExt(), YACS::ENGINE::AbstractPoint::isSimplyLinkedAfter(), YACS::ENGINE::AbstractPoint::IsSimplyLinkedAfterExt(), YACS::HMI::CommandAddLink::localExecute(), YACS::ENGINE::Bloc::performCFComputationsOnlyOneLevel(), YACS::HMI::SubjectNode::restoreLinks(), and YACS::HMI::SubjectNode::saveLinks().

{ return &_outGate; }

list< Node * > Node::getOutNodes

(

)

const

get the set of all nodes connected to the outGate

Definition at line 181 of file Node.cxx.

References _outGate, YACS::ENGINE::OutGate::edSetInGate(), and PMMLBasicsTestLauncher::ret.

Referenced by insertNodeChildrenInSet().

{
  list<Node *> ret;
  list<InGate *> inGates=_outGate.edSetInGate();
  for(list<InGate *>::iterator iter=inGates.begin();iter!=inGates.end();iter++)
    ret.push_back((*iter)->getNode());
  return ret;
}

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

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 in YACS::ENGINE::ForEachLoop, YACS::ENGINE::Switch, YACS::ENGINE::OptimizerLoop, YACS::ENGINE::ComposedNode, YACS::ENGINE::DynParaLoop, and YACS::ENGINE::ForLoop.

Definition at line 271 of file Node.cxx.

References PMMLBasicsTestLauncher::ret.

Referenced by YACS::ENGINE::ComposedNode::getOutPort().

{
  OutPort *ret;
  try
    {
      ret=getOutputPort(name);
    }
  catch(Exception& e)
    {
      ret=getOutputDataStreamPort(name);
    }
  return ret;
}

virtual std::string YACS::ENGINE::Node::getOutPortName ( const OutPort *  ) const throw (Exception)

pure virtual

Implemented in YACS::ENGINE::ComposedNode, and YACS::ENGINE::ElementaryNode.

Referenced by YACS::ENGINE::OptimizerLoop::initInterceptors().

virtual OutputDataStreamPort* YACS::ENGINE::Node::getOutputDataStreamPort ( const std::string &  name ) const throw (Exception)

pure virtual

Implemented in YACS::ENGINE::ComposedNode, YACS::ENGINE::ElementaryNode, and YACS::ENGINE::DFToDSForLoop.

Referenced by YACS::ENGINE::InputPort4DF2DS::getAllRepresentants(), YACS::ENGINE::ComposedNode::getOutputDataStreamPort(), YACS::HMI::CommandRenameOutDataPort::localExecute(), YACS::HMI::CommandAddLink::localExecute(), YACS::HMI::CommandSetDSPortProperties::localExecute(), YACS::HMI::CommandSetLinkProperties::localExecute(), YACS::HMI::CommandDestroy::localExecute(), YACS::HMI::CommandRenameOutDataPort::localReverse(), YACS::HMI::CommandAddLink::localReverse(), YACS::HMI::CommandSetDSPortProperties::localReverse(), and YACS::HMI::CommandSetLinkProperties::localReverse().

virtual OutputPort* YACS::ENGINE::Node::getOutputPort ( const std::string &  name ) const throw (Exception)

pure virtual

Implemented in YACS::ENGINE::ForEachLoop, YACS::ENGINE::DSToDFForLoop, YACS::ENGINE::OptimizerLoop, YACS::ENGINE::ComposedNode, YACS::ENGINE::DynParaLoop, YACS::ENGINE::ElementaryNode, and YACS::ENGINE::ForLoop.

Referenced by YACS::HMI::GuiEditor::CreateOutputPort(), YACS::ENGINE::InputDataStreamPort4DS2DF::getAllRepresentants(), YACS::ENGINE::Proc::getOutPortValue(), YACS::ENGINE::ComposedNode::getOutputPort(), YACS::HMI::CommandRenameOutDataPort::localExecute(), YACS::HMI::CommandSetOutPortValue::localExecute(), YACS::HMI::CommandAddLink::localExecute(), YACS::HMI::CommandDestroy::localExecute(), YACS::HMI::CommandRenameOutDataPort::localReverse(), YACS::HMI::CommandSetOutPortValue::localReverse(), YACS::HMI::CommandAddLink::localReverse(), YACSPMMLBasicsTest1::testYACSdriver_LRANN(), YACSPMMLBasicsTest1::testYACSdriver_PmmlDoesNotExist(), YACSPMMLBasicsTest1::testYACSdriverLinearRegression(), YACSPMMLBasicsTest1::testYACSdriverNeuralNetwork(), and YACS::HMI::EditionLoop::update().

Proc * Node::getProc ( )

virtual

Reimplemented in YACS::ENGINE::Proc.

Definition at line 397 of file Node.cxx.

References _father, and getProc().

Referenced by YACS::HMI::SubjectNode::copy(), YACS::ENGINE::StudyInNode::execute(), YACS::ENGINE::StudyOutNode::execute(), getProc(), YACS::ENGINE::ElementaryNode::getReadyTasks(), YACS::ENGINE::InputStudyPort::putDataInStudy(), YACS::HMI::SubjectNode::reparent(), YACS::ENGINE::OptimizerLoop::setAlgorithm(), YACS::ENGINE::SalomeOptimizerLoop::simpleClone(), and YACS::ENGINE::OptimizerLoop::simpleClone().

{
  if(!_father)
    return 0;
  return _father->getProc();
}

const Proc * Node::getProc ( ) const

virtual

Reimplemented in YACS::ENGINE::Proc.

Definition at line 404 of file Node.cxx.

References _father, and getProc().

{
  if(!_father)
    return 0;
  return _father->getProc();
}

virtual std::list<ProgressWeight> YACS::ENGINE::Node::getProgressWeight ( ) const

pure virtual

Implemented in YACS::ENGINE::ForEachLoop, YACS::ENGINE::Switch, YACS::ENGINE::ComposedNode, YACS::ENGINE::ElementaryNode, and YACS::ENGINE::ForLoop.

std::map< std::string, std::string > Node::getProperties

(

)

Definition at line 480 of file Node.cxx.

References _father, _propertyMap, and getProperties().

Referenced by YACS::ENGINE::SalomeContainerTools::CreateComponentInstance(), YACS::ENGINE::SalomeNode::execute(), and getProperties().

{
  std::map<std::string,std::string> amap=_propertyMap;
  if(_father)
    {
      std::map<std::string,std::string> fatherMap=_father->getProperties();
      amap.insert(fatherMap.begin(),fatherMap.end());
    }

  return amap;
}

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

virtual

Definition at line 468 of file Node.cxx.

References _father, _propertyMap, and getProperty().

Referenced by YACS::ENGINE::SalomeContainerTools::CreateComponentInstance(), YACS::ENGINE::StudyInNode::execute(), YACS::ENGINE::StudyOutNode::execute(), YACS::ENGINE::SalomeProc::getDefaultStudyId(), getProperty(), and YACS::ENGINE::SalomeProc::init().

{
  std::map<std::string,std::string>::iterator it=_propertyMap.find(name);

  if(it != _propertyMap.end())
    return it->second;
  else if(_father)
    return _father->getProperty(name);
  else
    return "";
}

std::map<std::string,std::string> YACS::ENGINE::Node::getPropertyMap ( )

inline

Definition at line 168 of file Node.hxx.

Referenced by YACS::HMI::SubjectNode::getProperties(), and YACS::HMI::CommandSetNodeProperties::localExecute().

{ return _propertyMap; }

std::string Node::getQualifiedName

(

)

const

same as Node::getName() in most cases, but differs for children of switch

used by writeDot to distinguish children of switch, by adding a prefix to the name. prefix is built on case id.

Definition at line 597 of file Node.cxx.

References _father, YACS::ENGINE::ComposedNode::getMyQualifiedName(), and getName().

Referenced by YACS::ENGINE::ComposedNode::getChildName(), YACS::ENGINE::ComposedNode::getPortName(), YACS::ENGINE::Proc::getXMLState(), Proc_i::getXMLState(), YACS::HMI::CommandCopyNode::localExecute(), YACS::ENGINE::Bloc::writeDot(), YACS::ENGINE::Proc::writeDot(), writeDot(), and YACS::ENGINE::Loop::writeDot().

{
  if(_father)
    return _father->getMyQualifiedName(this);
  return getName();
}

virtual void YACS::ENGINE::Node::getReadyTasks ( std::vector< Task * > &  tasks )

pure virtual

Implemented in YACS::ENGINE::ForEachLoop, YACS::ENGINE::Loop, YACS::ENGINE::Switch, YACS::ENGINE::DSToDFForLoop, YACS::ENGINE::OptimizerLoop, YACS::ENGINE::ElementaryNode, YACS::ENGINE::DFToDSForLoop, and YACS::ENGINE::Bloc.

Referenced by YACS::ENGINE::ComposedNode::getNextTasks(), and YACS::ENGINE::Loop::getReadyTasks().

virtual std::list<ElementaryNode *> YACS::ENGINE::Node::getRecursiveConstituents ( ) const

pure virtual

Implemented in YACS::ENGINE::ComposedNode, and YACS::ENGINE::ElementaryNode.

ComposedNode * Node::getRootNode ( ) const throw (Exception)

virtual

Reimplemented in YACS::ENGINE::ComposedNode.

Definition at line 411 of file Node.cxx.

References _father.

Referenced by YACS::ENGINE::InPort::edRemoveAllLinksLinkedWithMe(), getId(), YACS::ENGINE::ComposedNode::getRootNode(), and YACS::HMI::GuiExecutor::setInPortValue().

{
  if(!_father)
    throw Exception("No root node");
  ComposedNode *iter=_father;
  while(iter->_father)
    iter=iter->_father;
  return (ComposedNode *)iter;
}

std::list< InPort * > Node::getSetOfInPort

(

)

const

Definition at line 285 of file Node.cxx.

References getSetOfInputDataStreamPort(), getSetOfInputPort(), and PMMLBasicsTestLauncher::ret.

Referenced by YACS::ENGINE::ElementaryNode::getAllInPortsComingFromOutsideOfCurrentScope(), YACS::ENGINE::ComposedNode::getAllInPortsComingFromOutsideOfCurrentScope(), YACS::ENGINE::DynParaLoop::prepareInputsFromOutOfScope(), and YACS::HMI::SceneElementaryNodeItem::reorganize().

{
  list<InPort *> ret;
  list<InputPort *> data=getSetOfInputPort();
  ret.insert(ret.end(),data.begin(),data.end());
  list<InputDataStreamPort *> ds=getSetOfInputDataStreamPort();
  ret.insert(ret.end(),ds.begin(),ds.end());
  return ret;
}

virtual std::list<InputDataStreamPort *> YACS::ENGINE::Node::getSetOfInputDataStreamPort ( ) const

pure virtual

Implemented in YACS::ENGINE::ComposedNode, and YACS::ENGINE::ElementaryNode.

Referenced by getSetOfInPort(), and YACS::ENGINE::VisitorSaveSchema::writeInputDataStreamPorts().

virtual std::list<InputPort *> YACS::ENGINE::Node::getSetOfInputPort ( ) const

pure virtual

Implemented in YACS::ENGINE::ForEachLoop, YACS::ENGINE::Loop, YACS::ENGINE::Switch, YACS::ENGINE::DynParaLoop, YACS::ENGINE::ComposedNode, YACS::ENGINE::OptimizerLoop, and YACS::ENGINE::ElementaryNode.

Referenced by edGetSetOfUnitializedInputPort(), getSetOfInPort(), and YACS::ENGINE::VisitorSaveSchema::writeInputPorts().

virtual std::vector< std::pair<InPort *, OutPort *> > YACS::ENGINE::Node::getSetOfLinksComingInCurrentScope ( ) const

pure virtual

Implemented in YACS::ENGINE::ComposedNode, and YACS::ENGINE::ElementaryNode.

Referenced by YACS::HMI::SubjectNode::registerUndoDestroy(), YACS::HMI::SubjectNode::removeExternalLinks(), YACS::HMI::SubjectNode::saveLinks(), and YACS::HMI::SceneNodeItem::showOutScopeLinks().

virtual std::vector< std::pair<OutPort *, InPort *> > YACS::ENGINE::Node::getSetOfLinksLeavingCurrentScope ( ) const

pure virtual

Implemented in YACS::ENGINE::ComposedNode, and YACS::ENGINE::ElementaryNode.

Referenced by YACS::ENGINE::DynParaLoop::cloneAndPlaceNodesCoherently(), YACS::HMI::SubjectNode::registerUndoDestroy(), YACS::HMI::SubjectNode::removeExternalLinks(), YACS::HMI::SubjectNode::saveLinks(), and YACS::HMI::SceneNodeItem::showOutScopeLinks().

std::list< OutPort * > Node::getSetOfOutPort

(

)

const

Definition at line 295 of file Node.cxx.

References getSetOfOutputDataStreamPort(), getSetOfOutputPort(), and PMMLBasicsTestLauncher::ret.

Referenced by YACS::ENGINE::ElementaryNode::getAllOutPortsLeavingCurrentScope(), YACS::ENGINE::ComposedNode::getAllOutPortsLeavingCurrentScope(), YACS::HMI::SceneBlocItem::getNodesInfo(), YACS::ENGINE::ComposedNode::getSetOfInternalLinks(), and YACS::HMI::SceneElementaryNodeItem::reorganize().

{
  list<OutPort *> ret;
  list<OutputPort *> data=getSetOfOutputPort();
  ret.insert(ret.end(),data.begin(),data.end());
  list<OutputDataStreamPort *> ds=getSetOfOutputDataStreamPort();
  ret.insert(ret.end(),ds.begin(),ds.end());
  return ret;
}

virtual std::list<OutputDataStreamPort *> YACS::ENGINE::Node::getSetOfOutputDataStreamPort ( ) const

pure virtual

Implemented in YACS::ENGINE::ComposedNode, and YACS::ENGINE::ElementaryNode.

Referenced by getSetOfOutPort(), YACS::ENGINE::VisitorSaveSchema::writeOutputDataStreamPorts(), and YACS::ENGINE::VisitorSaveSchema::writeSimpleStreamLinks().

virtual std::list<OutputPort *> YACS::ENGINE::Node::getSetOfOutputPort ( ) const

pure virtual

Implemented in YACS::ENGINE::OptimizerLoop, YACS::ENGINE::ComposedNode, YACS::ENGINE::DynParaLoop, YACS::ENGINE::ElementaryNode, and YACS::ENGINE::ForLoop.

Referenced by getSetOfOutPort(), and YACS::ENGINE::VisitorSaveSchema::writeOutputPorts().

virtual YACS::StatesForNode YACS::ENGINE::Node::getState ( ) const

inlinevirtual

Reimplemented in YACS::ENGINE::ElementaryNode.

Definition at line 115 of file Node.hxx.

Referenced by YACS::ENGINE::DynParaLoop::forwardExecStateToOriginalBody(), getEffectiveState(), YACS::ENGINE::Switch::getEffectiveState(), getErrorReport(), YACS::ENGINE::Switch::getProgressWeight(), YACS::ENGINE::ElementaryNode::getState(), resetState(), YACS::HMI::SchemaNodeItem::update(), YACS::HMI::SchemaComposedNodeItem::update(), YACS::HMI::SceneNodeItem::updateState(), YACS::ENGINE::OptimizerLoop::updateStateOnFinishedEventFrom(), YACS::ENGINE::ForEachLoop::updateStateOnFinishedEventFrom(), YACS::ENGINE::VisitorSaveState::visitBloc(), YACS::ENGINE::VisitorSaveSchema::visitBloc(), YACS::ENGINE::VisitorSalomeSaveState::visitForEachLoop(), YACS::ENGINE::VisitorSaveState::visitForEachLoop(), YACS::ENGINE::VisitorSaveSchema::visitForEachLoop(), YACS::ENGINE::VisitorSaveState::visitForLoop(), YACS::ENGINE::VisitorSaveSchema::visitForLoop(), YACS::ENGINE::VisitorSaveState::visitLoop(), YACS::ENGINE::VisitorSaveState::visitOptimizerLoop(), YACS::ENGINE::VisitorSaveSchema::visitOptimizerLoop(), YACS::ENGINE::VisitorSaveState::visitProc(), YACS::ENGINE::VisitorSaveState::visitSwitch(), YACS::ENGINE::VisitorSaveSchema::visitSwitch(), YACS::ENGINE::VisitorSaveState::visitWhileLoop(), and YACS::ENGINE::VisitorSaveSchema::visitWhileLoop().

{ return _state; }

std::string Node::getStateName ( YACS::StatesForNode  state )

static

Return the name of a state.

Definition at line 785 of file Node.cxx.

References CORBAEngineTest::state.

Referenced by YACS::ENGINE::Executor::functionForTaskExecution(), YACS::ENGINE::Executor::launchTasks(), YACS::ENGINE::Executor::loadTask(), and main().

{
  static NodeStateNameMap nodeStateNameMap;
  return nodeStateNameMap[state];
}

void Node::init ( bool  start = true )

virtual

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

Reimplemented in YACS::ENGINE::ForEachLoop, YACS::ENGINE::Loop, YACS::ENGINE::PyFuncNode, YACS::ENGINE::Switch, YACS::ENGINE::SplitterNode, YACS::ENGINE::OptimizerLoop, YACS::ENGINE::DynParaLoop, YACS::ENGINE::ElementaryNode, YACS::ENGINE::ComposedNode, YACS::ENGINE::WhileLoop, YACS::ENGINE::SalomeProc, YACS::ENGINE::Bloc, and YACS::ENGINE::ForLoop.

Definition at line 99 of file Node.cxx.

References _inGate, _outGate, _state, YACS::DISABLED, exDisabledState(), YACS::ENGINE::OutGate::exReset(), YACS::ENGINE::InGate::exReset(), YACS::READY, and setState().

Referenced by YACS::ENGINE::Bloc::init(), YACS::ENGINE::ComposedNode::init(), YACS::ENGINE::DynParaLoop::init(), YACS::ENGINE::Loop::init(), YACS::ENGINE::ForEachLoop::updateStateForWorkNodeOnFinishedEventFrom(), YACS::ENGINE::WhileLoop::updateStateOnFinishedEventFrom(), and YACS::ENGINE::ForLoop::updateStateOnFinishedEventFrom().

{
  _inGate.exReset();
  _outGate.exReset();
  if(_state == YACS::DISABLED)
    {
      exDisabledState(); // to refresh propagation of DISABLED state 
      return;
    }
  setState(YACS::READY);
}

virtual int YACS::ENGINE::Node::isModified ( )

inlinevirtual

Definition at line 186 of file Node.hxx.

{ return _modified; }

int Node::isValid ( )

virtual

indicates if the node is valid (returns 1) or not (returns 0)

This method is useful when editing a schema. It has no meaning in execution. When a node is edited, its modified method must be called so when isValid is called, its state is updated (call to edUpdateState) before returning the validity check

Definition at line 688 of file Node.cxx.

References _modified, _state, edUpdateState(), and YACS::INVALID.

Referenced by YACS::HMI::SubjectNode::isValid(), main(), YACS::HMI::GenericGui::onRunLoadedSchema(), and YACS::HMI::EditionProc::synchronize().

{
  if(_modified)
    edUpdateState();
  if(_state > YACS::INVALID)
    return 1;
  else
    return 0;
}

void Node::modified ( )

virtual

Sets Node in modified state and its father if it exists.

Reimplemented in YACS::ENGINE::Proc.

Definition at line 763 of file Node.cxx.

References _father, _modified, DEBTRACE, getName(), and modified().

Referenced by YACS::ENGINE::DynParaLoop::checkConsistencyAndSetNode(), YACS::ENGINE::Switch::edChangeCase(), YACS::ENGINE::Loop::edRemoveNode(), YACS::ENGINE::Loop::edSetNode(), YACS::ENGINE::SalomeOptimizerLoop::loadAlgorithm(), YACS::ENGINE::OptimizerLoop::loadAlgorithm(), YACS::ENGINE::Port::modified(), modified(), YACS::ENGINE::DynParaLoop::removeNode(), and YACS::ENGINE::OptimizerLoop::setAlgorithm().

{
  DEBTRACE("Node::modified() " << getName());
  _modified=1;
  if(_father)
    _father->modified();
}

bool Node::operator<

(

const Node &

other

)

const

Definition at line 331 of file Node.cxx.

References _father.

{
  const ComposedNode *iter=_father;
  while(iter!=0 && iter!=(&other))
    iter=iter->_father;
  return iter==(&other);
}

bool Node::operator>

(

const Node &

other

)

const

Definition at line 323 of file Node.cxx.

References _father.

{
  const ComposedNode *iter=other._father;
  while(iter!=0 && iter!=this)
    iter=iter->_father;
  return iter==this;
}

virtual void YACS::ENGINE::Node::performDuplicationOfPlacement ( const Node &  other )

protectedpure virtual

performs a duplication of placement using clone method of containers and components. clone behaviour is driven by attachOnCloning attribute.

Implemented in YACS::ENGINE::InlineNode, YACS::ENGINE::ElementaryNode, YACS::ENGINE::ComposedNode, and YACS::ENGINE::ServiceNode.

Referenced by clone().

virtual void YACS::ENGINE::Node::performShallowDuplicationOfPlacement ( const Node &  other )

protectedpure virtual

performs a also duplication of placement but here containers and components are not copied at all whatever the value of attachedOnCloning.

Implemented in YACS::ENGINE::InlineNode, YACS::ENGINE::ElementaryNode, YACS::ENGINE::ComposedNode, and YACS::ENGINE::ServiceNode.

Referenced by cloneWithoutCompAndContDeepCpy().

void Node::resetState ( int  level )

virtual

Reset the node state depending on the parameter level.

Reimplemented in YACS::ENGINE::ForEachLoop, and YACS::ENGINE::ComposedNode.

Definition at line 809 of file Node.cxx.

References _state, YACS::ACTIVATED, DEBTRACE, YACS::DONE, YACS::ERROR, YACS::FAILED, YACS::ENGINE::InGate::getBackLinks(), getInGate(), getName(), getState(), YACS::READY, YACS::ENGINE::InGate::setPrecursorDone(), and setState().

Referenced by YACS::ENGINE::ComposedNode::resetState().

{
  DEBTRACE("Node::resetState " << getName() << "," << level << "," << _state);
  if(_state==YACS::ERROR || _state==YACS::FAILED || _state==YACS::ACTIVATED)
    {
      setState(YACS::READY);
      InGate* inGate = getInGate();
      std::list<OutGate*> backlinks = inGate->getBackLinks();
      for (std::list<OutGate*>::iterator io = backlinks.begin(); io != backlinks.end(); io++)
        {
          Node* fromNode = (*io)->getNode();
          if(fromNode->getState() == YACS::DONE)
            {
              inGate->setPrecursorDone(*io);
            }
        }
    }
}

void Node::sendEvent ( const std::string &  event )

virtual

emit notification to all observers registered with the dispatcher

The dispatcher is unique and can be obtained by getDispatcher()

Definition at line 656 of file Node.cxx.

References DEBTRACE, YACS::ENGINE::Dispatcher::dispatch(), and YACS::ENGINE::Dispatcher::getDispatcher().

Referenced by YACS::ENGINE::ForLoop::exUpdateProgress(), YACS::ENGINE::ForEachLoop::exUpdateProgress(), and setState().

{
  DEBTRACE("Node::sendEvent " << event);
  Dispatcher* disp=Dispatcher::getDispatcher();
  disp->dispatch(this,event);
}

void Node::sendEvent2 ( const std::string &  event, void *  something  )

virtual

emit notification to all observers registered with the dispatcher

The dispatcher is unique and can be obtained by getDispatcher()

Definition at line 667 of file Node.cxx.

References YACS::ENGINE::Dispatcher::dispatch2(), and YACS::ENGINE::Dispatcher::getDispatcher().

Referenced by YACS::ENGINE::ForEachLoop::updateStateForWorkNodeOnFinishedEventFrom().

{
  Dispatcher* disp=Dispatcher::getDispatcher();
  disp->dispatch2(this,event,something);
}

virtual void YACS::ENGINE::Node::setErrorDetails ( const std::string &  error )

inlinevirtual

Definition at line 184 of file Node.hxx.

Referenced by YACS::ENGINE::PythonEntry::commonRemoteLoadPart1(), YACS::ENGINE::PythonEntry::commonRemoteLoadPart2(), YACS::ENGINE::PythonEntry::commonRemoteLoadPart3(), and YACS::ENGINE::DynParaLoop::forwardExecStateToOriginalBody().

{ _errorDetails=error; }

void Node::setName

(

const std::string &

name

)

Change the name of the node.

raise an exception if the name is already used in the scope of its father

Parameters

name	: the new name

Definition at line 159 of file Node.cxx.

References _father, _name, YACS::ENGINE::ComposedNode::getChildByName(), YACS::ENGINE::ComposedNode::getName(), and YACS::ENGINE::ComposedNode::isNameAlreadyUsed().

Referenced by YACS::ENGINE::ElementaryNode::getReadyTasks(), YACS::HMI::CommandAddNodeFromCatalog::localExecute(), YACS::HMI::CommandPutInComposedNode::localExecute(), YACS::HMI::CommandCopyNode::localExecute(), YACS::HMI::CommandRenameNode::localExecute(), and YACS::HMI::CommandRenameNode::localReverse().

{
  if(_father)
    {
      if(_father->isNameAlreadyUsed(name))
        {
          if ( _father->getChildByName(name) != this )
            {
              std::string what("Name "); 
              what+=name;
              what+=" already exists in the scope of "; what+=_father->getName();
              throw Exception(what);
            }
        }
    }
  _name=name;
}

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

virtual

Definition at line 492 of file Node.cxx.

References _propertyMap.

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

{
  _propertyMap.clear();
  _propertyMap=properties;
}

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

virtual

Definition at line 462 of file Node.cxx.

References _propertyMap, and DEBTRACE.

Referenced by YACS::HMI::GenericGui::createContext(), and YACS::ENGINE::InPropertyPort::exNewPropertyValue().

{
    DEBTRACE("Node::setProperty " << name << " " << value);
    _propertyMap[name]=value;
}

void Node::setState

(

YACS::StatesForNode

theState

)

Sets the given state for node.

It is strongly recommended to use this function if you want to change the state of the node, instead of direct access to _state field (_state = ...).

Definition at line 617 of file Node.cxx.

References _state, DEBTRACE, getName(), and sendEvent().

Referenced by YACS::ENGINE::FakeNodeForOptimizerLoop::aborted(), YACS::ENGINE::FakeNodeForSwitch::aborted(), YACS::ENGINE::ElementaryNode::aborted(), YACS::ENGINE::FakeNodeForForEachLoop::aborted(), YACS::ENGINE::FakeNodeForLoop::aborted(), YACS::ENGINE::ElementaryNode::begin(), YACS::ENGINE::ElementaryNode::connected(), YACS::ENGINE::ElementaryNode::edUpdateState(), YACS::ENGINE::ComposedNode::edUpdateState(), YACS::ENGINE::ElementaryNode::ensureLoading(), ensureLoading(), exDisabledState(), exFailedState(), YACS::ENGINE::ForLoop::exUpdateState(), YACS::ENGINE::WhileLoop::exUpdateState(), YACS::ENGINE::Bloc::exUpdateState(), YACS::ENGINE::ElementaryNode::exUpdateState(), YACS::ENGINE::OptimizerLoop::exUpdateState(), YACS::ENGINE::Switch::exUpdateState(), exUpdateState(), YACS::ENGINE::ForEachLoop::exUpdateState(), YACS::ENGINE::FakeNodeForLoop::FakeNodeForLoop(), YACS::ENGINE::OptimizerLoop::finalize(), YACS::ENGINE::FakeNodeForOptimizerLoop::finished(), YACS::ENGINE::FakeNodeForSwitch::finished(), YACS::ENGINE::ElementaryNode::finished(), YACS::ENGINE::FakeNodeForForEachLoop::finished(), YACS::ENGINE::FakeNodeForLoop::finished(), YACS::ENGINE::DynParaLoop::forwardExecStateToOriginalBody(), YACS::ENGINE::Bloc::getReadyTasks(), YACS::ENGINE::Switch::getReadyTasks(), YACS::ENGINE::Loop::getReadyTasks(), YACS::ENGINE::ForEachLoop::getReadyTasks(), YACS::ENGINE::ElementaryNode::init(), init(), YACS::ENGINE::PyFuncNode::init(), resetState(), YACS::ENGINE::StateLoader(), YACS::ENGINE::ForEachLoop::updateStateForFinalizeNodeOnFinishedEventFrom(), YACS::ENGINE::ForEachLoop::updateStateForInitNodeOnFinishedEventFrom(), YACS::ENGINE::ForEachLoop::updateStateForWorkNodeOnFinishedEventFrom(), YACS::ENGINE::ComposedNode::updateStateFrom(), YACS::ENGINE::Bloc::updateStateOnFailedEventFrom(), YACS::ENGINE::DynParaLoop::updateStateOnFailedEventFrom(), YACS::ENGINE::ComposedNode::updateStateOnFailedEventFrom(), YACS::ENGINE::WhileLoop::updateStateOnFinishedEventFrom(), YACS::ENGINE::ForLoop::updateStateOnFinishedEventFrom(), YACS::ENGINE::Bloc::updateStateOnFinishedEventFrom(), YACS::ENGINE::OptimizerLoop::updateStateOnFinishedEventFrom(), YACS::ENGINE::Switch::updateStateOnFinishedEventFrom(), and YACS::ENGINE::ComposedNode::updateStateOnStartEventFrom().

{
  DEBTRACE("Node::setState: " << getName() << " " << theState);
  _state = theState;
  // emit notification to all observers registered with the dispatcher on any change of the node's state
  sendEvent("status");
}

void Node::shutdown ( int  level )

virtual

Stop all pending activities of the node.

This method should be called when a Proc is finished and must be deleted from the YACS server

Reimplemented in YACS::ENGINE::DynParaLoop, YACS::ENGINE::PyFuncNode, YACS::ENGINE::SalomeNode, YACS::ENGINE::PythonNode, and YACS::ENGINE::ComposedNode.

Definition at line 795 of file Node.cxx.

{
  if(level==0)return;
}

virtual Node* YACS::ENGINE::Node::simpleClone ( ComposedNode *  father, bool  editionOnly = true  ) const

protectedpure virtual

Implemented in YACS::ENGINE::ForEachLoop, YACS::ENGINE::Switch, YACS::ENGINE::FakeNodeForLoop, YACS::ENGINE::OptimizerLoop, YACS::ENGINE::FakeNodeForForEachLoop, YACS::ENGINE::DSToDFForLoop, YACS::ENGINE::PyFuncNode, YACS::ENGINE::SplitterNode, YACS::ENGINE::FakeNodeForSwitch, YACS::ENGINE::DFToDSForLoop, YACS::ENGINE::SalomeNode, YACS::ENGINE::PythonNode, YACS::ENGINE::WhileLoop, YACS::ENGINE::CppNode, YACS::ENGINE::StudyOutNode, YACS::ENGINE::CORBANode, YACS::ENGINE::DistributedPythonNode, YACS::ENGINE::ForLoop, YACS::ENGINE::FakeNodeForOptimizerLoop, YACS::ENGINE::Bloc, YACS::ENGINE::SalomePythonNode, YACS::ENGINE::PresetNode, YACS::ENGINE::SalomeOptimizerLoop, YACS::ENGINE::StudyInNode, YACS::ENGINE::OutNode, and YACS::ENGINE::XmlNode.

Referenced by clone(), YACS::ENGINE::DynParaLoop::cloneAndPlaceNodesCoherently(), cloneWithoutCompAndContDeepCpy(), and YACS::ENGINE::Loop::Loop().

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

inlinevirtual

Reimplemented in YACS::ENGINE::ForEachLoop, YACS::ENGINE::Loop, YACS::ENGINE::Switch, YACS::ENGINE::PyFuncNode, YACS::ENGINE::ComposedNode, YACS::ENGINE::ElementaryNode, YACS::ENGINE::InlineFuncNode, YACS::ENGINE::OptimizerLoop, YACS::ENGINE::PythonNode, YACS::ENGINE::Proc, YACS::ENGINE::SalomeNode, YACS::ENGINE::Bloc, YACS::ENGINE::InlineNode, YACS::ENGINE::DistributedPythonNode, YACS::ENGINE::StudyOutNode, YACS::ENGINE::ForLoop, YACS::ENGINE::ServiceNode, YACS::ENGINE::CORBANode, YACS::ENGINE::WhileLoop, YACS::ENGINE::DataNode, YACS::ENGINE::ServerNode, YACS::ENGINE::SalomeProc, YACS::ENGINE::ServiceInlineNode, YACS::ENGINE::PresetNode, YACS::ENGINE::StudyInNode, and YACS::ENGINE::SalomeOptimizerLoop.

Definition at line 182 of file Node.hxx.

{ return "YACS__ENGINE__Node"; }

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

virtual

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

Parameters

os	: the input stream

Reimplemented in YACS::ENGINE::ForEachLoop, YACS::ENGINE::Loop, YACS::ENGINE::Switch, YACS::ENGINE::Proc, and YACS::ENGINE::Bloc.

Definition at line 582 of file Node.cxx.

References getColorState(), getEffectiveState(), getId(), getImplementation(), getQualifiedName(), and CORBAEngineTest::state.

Referenced by YACS::ENGINE::Switch::writeDot(), YACS::ENGINE::Loop::writeDot(), and YACS::ENGINE::ForEachLoop::writeDot().

{
  os << getId() << "[fillcolor=\"" ;
  YACS::StatesForNode state=getEffectiveState();
  os << getColorState(state);
  os << "\" label=\"" << getImplementation() << "Node:" ;
  os << getQualifiedName() <<"\"];\n";
}

Friends And Related Function Documentation

friend class Bloc

friend

Definition at line 69 of file Node.hxx.

friend class ComposedNode

friend

Definition at line 77 of file Node.hxx.

friend class DynParaLoop

friend

Definition at line 75 of file Node.hxx.

friend class ElementaryNode

friend

Definition at line 78 of file Node.hxx.

friend class ForEachLoop

friend

Definition at line 76 of file Node.hxx.

friend class InPropertyPort

friend

Definition at line 74 of file Node.hxx.

Referenced by Node().

friend class InputPort

friend

Definition at line 72 of file Node.hxx.

friend class Loop

friend

Definition at line 70 of file Node.hxx.

friend class OutputPort

friend

Definition at line 73 of file Node.hxx.

void StateLoader ( Node *  node, YACS::StatesForNode  state  )

friend

friend class Switch

friend

Definition at line 71 of file Node.hxx.

friend class Visitor

friend

Definition at line 79 of file Node.hxx.

Member Data Documentation

YACS::Colour YACS::ENGINE::Node::_colour

mutable

Definition at line 82 of file Node.hxx.

Referenced by YACS::ENGINE::Bloc::findAllPathsStartingFrom(), and YACS::ENGINE::Bloc::splitIntoIndependantGraph().

std::string YACS::ENGINE::Node::_errorDetails

protected

Definition at line 91 of file Node.hxx.

Referenced by YACS::ENGINE::OptimizerLoop::checkBasicConsistency(), YACS::ENGINE::DistributedPythonNode::dealException(), YACS::ENGINE::ElementaryNode::edUpdateState(), YACS::ENGINE::ComposedNode::edUpdateState(), YACS::ENGINE::StudyInNode::execute(), YACS::ENGINE::FakeNodeForOptimizerLoop::execute(), YACS::ENGINE::CORBANode::execute(), YACS::ENGINE::DistributedPythonNode::execute(), YACS::ENGINE::StudyOutNode::execute(), YACS::ENGINE::SalomeNode::execute(), YACS::ENGINE::PythonNode::executeLocal(), YACS::ENGINE::PyFuncNode::executeLocal(), YACS::ENGINE::PythonNode::executeRemote(), YACS::ENGINE::PyFuncNode::executeRemote(), YACS::ENGINE::ElementaryNode::exUpdateState(), YACS::ENGINE::ElementaryNode::getErrorDetails(), YACS::ENGINE::DynParaLoop::getErrorReport(), YACS::ENGINE::ComposedNode::getErrorReport(), getErrorReport(), YACS::ENGINE::ServerNode::load(), YACS::ENGINE::ServiceNode::load(), YACS::ENGINE::DistributedPythonNode::load(), YACS::ENGINE::SalomeOptimizerLoop::loadAlgorithm(), YACS::ENGINE::OptimizerLoop::loadAlgorithm(), YACS::ENGINE::PyFuncNode::loadLocal(), YACS::ENGINE::PyFuncNode::PyFuncNode(), YACS::ENGINE::PythonNode::PythonNode(), YACS::ENGINE::ComposedNode::updateStateFrom(), and YACS::ENGINE::OptimizerLoop::updateStateOnFinishedEventFrom().

ComposedNode* YACS::ENGINE::Node::_father

protected

Definition at line 88 of file Node.hxx.

Referenced by YACS::ENGINE::OutPort::calculateHistoryOfLinkWith(), YACS::ENGINE::DynParaLoop::checkConsistencyAndSetNode(), checkHavingCommonFather(), YACS::ENGINE::ComposedNode::checkInMyDescendance(), YACS::ENGINE::DFToDSForLoop::DFToDSForLoop(), YACS::ENGINE::DSToDFForLoop::DSToDFForLoop(), YACS::ENGINE::Bloc::edAddChild(), YACS::ENGINE::ComposedNode::edAddLink(), YACS::ENGINE::ComposedNode::edRemoveLink(), YACS::ENGINE::Loop::edSetNode(), YACS::ENGINE::FakeNodeForForEachLoop::FakeNodeForForEachLoop(), YACS::ENGINE::FakeNodeForLoop::FakeNodeForLoop(), YACS::ENGINE::FakeNodeForOptimizerLoop::FakeNodeForOptimizerLoop(), YACS::ENGINE::FakeNodeForSwitch::FakeNodeForSwitch(), getAllAscendanceOf(), YACS::ENGINE::ComposedNode::getChildName(), YACS::ENGINE::ElementaryNode::getDynClonerIfExists(), getEffectiveState(), YACS::ENGINE::ComposedNode::getLowestCommonAncestor(), YACS::ENGINE::ComposedNode::getPortName(), getProc(), getProperties(), getProperty(), getQualifiedName(), YACS::ENGINE::ElementaryNode::getReadyTasks(), YACS::ENGINE::ComposedNode::getRootNode(), getRootNode(), YACS::ENGINE::ComposedNode::isInMyDescendance(), modified(), YACS::ENGINE::ComposedNode::notifyFrom(), operator<(), operator>(), YACS::ENGINE::SplitterNode::putSplittedValueOnRankTo(), setName(), and YACS::ENGINE::SplitterNode::SplitterNode().

std::string YACS::ENGINE::Node::_implementation

protected

Definition at line 95 of file Node.hxx.

Referenced by YACS::ENGINE::CORBANode::CORBANode(), YACS::ENGINE::CppNode::CppNode(), YACS::ENGINE::ElementaryNode::createInputPort(), YACS::ENGINE::ElementaryNode::createOutputPort(), getImplementation(), YACS::ENGINE::DistributedPythonNode::initMySelf(), YACS::ENGINE::OutNode::OutNode(), YACS::ENGINE::PresetNode::PresetNode(), YACS::ENGINE::PyFuncNode::PyFuncNode(), YACS::ENGINE::PythonNode::PythonNode(), YACS::ENGINE::SalomeNode::SalomeNode(), YACS::ENGINE::SalomePythonNode::SalomePythonNode(), YACS::ENGINE::StudyInNode::StudyInNode(), YACS::ENGINE::StudyOutNode::StudyOutNode(), and YACS::ENGINE::XmlNode::XmlNode().

InGate YACS::ENGINE::Node::_inGate

protected

Definition at line 84 of file Node.hxx.

Referenced by YACS::ENGINE::ElementaryNode::connected(), edDisconnectAllLinksWithMe(), exIsControlReady(), YACS::ENGINE::ForLoop::exUpdateState(), YACS::ENGINE::WhileLoop::exUpdateState(), YACS::ENGINE::Bloc::exUpdateState(), YACS::ENGINE::ElementaryNode::exUpdateState(), YACS::ENGINE::OptimizerLoop::exUpdateState(), YACS::ENGINE::Switch::exUpdateState(), exUpdateState(), YACS::ENGINE::ForEachLoop::exUpdateState(), init(), and YACS::ENGINE::ElementaryNode::initCommonPartWithoutStateManagement().

InPropertyPort* YACS::ENGINE::Node::_inPropertyPort

protected

Definition at line 86 of file Node.hxx.

Referenced by getInPropertyPort(), Node(), and ~Node().

int YACS::ENGINE::Node::_modified

protected

Definition at line 90 of file Node.hxx.

Referenced by YACS::ENGINE::ElementaryNode::edUpdateState(), YACS::ENGINE::ComposedNode::edUpdateState(), edUpdateState(), isValid(), YACS::ENGINE::Proc::modified(), and modified().

std::string YACS::ENGINE::Node::_name

protected

Definition at line 87 of file Node.hxx.

Referenced by YACS::ENGINE::DynParaLoop::checkConsistencyAndSetNode(), YACS::ENGINE::DFToDSForLoop::DFToDSForLoop(), YACS::ENGINE::DSToDFForLoop::DSToDFForLoop(), YACS::ENGINE::ElementaryNode::exUpdateState(), YACS::ENGINE::OptimizerLoop::exUpdateState(), YACS::ENGINE::DynParaLoop::init(), YACS::ENGINE::ServerNode::load(), YACS::ENGINE::ServiceNode::load(), YACS::ENGINE::Proc::setName(), and setName().

int YACS::ENGINE::Node::_numId

protected

Definition at line 94 of file Node.hxx.

Referenced by getNumId(), and Node().

OutGate YACS::ENGINE::Node::_outGate

protected

Definition at line 85 of file Node.hxx.

Referenced by edDisconnectAllLinksWithMe(), exDisabledState(), exFailedState(), exForwardFailed(), exForwardFinished(), getOutNodes(), and init().

std::map<std::string,std::string> YACS::ENGINE::Node::_propertyMap

protected

Definition at line 96 of file Node.hxx.

Referenced by YACS::ENGINE::ElementaryNode::createMultiDatastreamPorts(), YACS::ENGINE::Visitor::getNodeProperties(), getProperties(), getProperty(), YACS::ENGINE::ElementaryNode::getReadyTasks(), setProperties(), and setProperty().

YACS::StatesForNode YACS::ENGINE::Node::_state

protected

Definition at line 89 of file Node.hxx.

Referenced by YACS::ENGINE::FakeNodeForSwitch::aborted(), YACS::ENGINE::ElementaryNode::edUpdateState(), YACS::ENGINE::ComposedNode::edUpdateState(), YACS::ENGINE::ElementaryNode::ensureLoading(), ensureLoading(), YACS::ENGINE::ForLoop::exUpdateState(), YACS::ENGINE::WhileLoop::exUpdateState(), YACS::ENGINE::Bloc::exUpdateState(), YACS::ENGINE::ElementaryNode::exUpdateState(), YACS::ENGINE::OptimizerLoop::exUpdateState(), YACS::ENGINE::Switch::exUpdateState(), exUpdateState(), YACS::ENGINE::ForEachLoop::exUpdateState(), YACS::ENGINE::FakeNodeForForEachLoop::FakeNodeForForEachLoop(), YACS::ENGINE::FakeNodeForOptimizerLoop::FakeNodeForOptimizerLoop(), YACS::ENGINE::FakeNodeForSwitch::FakeNodeForSwitch(), getEffectiveState(), YACS::ENGINE::DynParaLoop::getErrorReport(), YACS::ENGINE::ComposedNode::getErrorReport(), YACS::ENGINE::Bloc::getReadyTasks(), YACS::ENGINE::ElementaryNode::getReadyTasks(), YACS::ENGINE::OptimizerLoop::getReadyTasks(), YACS::ENGINE::Switch::getReadyTasks(), YACS::ENGINE::Loop::getReadyTasks(), YACS::ENGINE::ForEachLoop::getReadyTasks(), YACS::ENGINE::ElementaryNode::init(), init(), YACS::ENGINE::PyFuncNode::init(), YACS::ENGINE::Bloc::isFinished(), YACS::ENGINE::ComposedNode::isFinished(), YACS::ENGINE::ElementaryNode::isReady(), isValid(), YACS::ENGINE::ComposedNode::resetState(), resetState(), setState(), and YACS::ENGINE::ForEachLoop::updateStateForWorkNodeOnFinishedEventFrom().

int Node::_total = 0

staticprotected

Definition at line 93 of file Node.hxx.

Referenced by Node().

std::map< int, Node * > Node::idMap

static

Definition at line 181 of file Node.hxx.

Referenced by YACS::ENGINE::Proc::getInPortValue(), YACS::ENGINE::Proc::getNodeContainerLog(), YACS::ENGINE::Proc::getNodeErrorDetails(), YACS::ENGINE::Proc::getNodeErrorReport(), YACS::ENGINE::Proc::getNodeProgress(), YACS::ENGINE::Proc::getNodeState(), YACS::ENGINE::Proc::getOutPortValue(), Proc_i::getState(), YACS::ENGINE::Proc::getXMLState(), Proc_i::getXMLState(), and Node().

const char Node::SEP_CHAR_IN_PORT ="."

staticprotected

Definition at line 92 of file Node.hxx.

Referenced by YACS::ENGINE::DynParaLoop::getDynInputPortByAbsName(), YACS::ENGINE::ForEachLoop::getDynOutPortByAbsName(), YACS::ENGINE::ComposedNode::getInputDataStreamPort(), YACS::ENGINE::ComposedNode::getInputPort(), YACS::ENGINE::ComposedNode::getOutPort(), YACS::ENGINE::ComposedNode::getOutputDataStreamPort(), YACS::ENGINE::ComposedNode::getOutputPort(), and YACS::ENGINE::ComposedNode::getPortName().

---

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

• src/engine/Node.hxx
• src/engine/Node.cxx