YACS::ENGINE::InlineFuncNode Class Reference

Class for calculation node (function) inlined (and executed) in the schema. More...

#include <InlineNode.hxx>

Inheritance diagram for YACS::ENGINE::InlineFuncNode:

Collaboration diagram for YACS::ENGINE::InlineFuncNode:

Public Member Functions
virtual void	setFname (const std::string &fname)
	Set the function name to use in node execution. More...
virtual std::string	getFname ()
void	accept (Visitor *visitor)
virtual	~InlineFuncNode ()
virtual std::string	typeName ()
virtual void	checkBasicConsistency () const throw (Exception)
Public Member Functions inherited from YACS::ENGINE::InlineNode
virtual void	setScript (const std::string &script)
	Set the script (as a string) to execute. More...
virtual std::string	getScript ()
virtual InlineNode *	cloneNode (const std::string &name)
	Return a new InlineNode node by making a copy of this node. More...
virtual	~InlineNode ()
virtual void	setExecutionMode (const std::string &mode)
virtual std::string	getExecutionMode ()
virtual void	setContainer (Container *container)
virtual Container *	getContainer ()
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...
bool	isDeployable () const
int	getMaxLevelOfParallelism () const
Public Member Functions inherited from YACS::ENGINE::ElementaryNode
virtual	~ElementaryNode ()
void	exUpdateState ()
	Update the node state. More...
void	init (bool start=true)
ComponentInstance *	getComponent ()
const ComponentInstance *	getComponent () const
YACS::StatesForNode	getState () const
void	getReadyTasks (std::vector< Task * > &tasks)
void	edRemovePort (Port *port) throw (Exception)
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 throw (Exception)
ComposedNode *	getDynClonerIfExists (const ComposedNode *levelToStop) const
int	getNumberOfInputPorts () const
int	getNumberOfOutputPorts () const
std::string	getInPortName (const InPort *) const throw (Exception)
std::string	getOutPortName (const OutPort *) const throw (Exception)
InputPort *	getInputPort (const std::string &name) const throw (Exception)
OutputPort *	getOutputPort (const std::string &name) const throw (Exception)
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 throw (Exception)
OutputDataStreamPort *	getOutputDataStreamPort (const std::string &name) const throw (Exception)
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) throw (Exception)
virtual OutputPort *	edAddOutputPort (const std::string &outputPortName, TypeCode *type) throw (Exception)
virtual InputDataStreamPort *	edAddInputDataStreamPort (const std::string &inputPortDSName, TypeCode *type) throw (Exception)
virtual OutputDataStreamPort *	edAddOutputDataStreamPort (const std::string &outputPortDSName, TypeCode *type) throw (Exception)
virtual void	edOrderInputPorts (const std::list< InputPort * > &ports)
virtual void	edOrderOutputPorts (const std::list< OutputPort * > &ports)
virtual void	edUpdateState ()
	update the status of the node More...
virtual void	ensureLoading ()
	Put this node into TOLOAD state when possible. More...
void	begin ()
bool	isReady ()
void	finished ()
void	aborted ()
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...
virtual void	addDatastreamPortToInitMultiService (const std::string &port_name, int number)
template<class PORT >
void	edRemovePortTypedFromSet (PORT *port, std::list< PORT * > &setOfPorts) throw (Exception)
template<class PORT >
bool	isPortNameAlreadyExist (const std::string &portName, const std::list< PORT * > &setOfPorts)
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...
virtual void	exFailedState ()
	Notify this node that its execution has failed. More...
virtual void	exDisabledState ()
	Notify this node that it has been disabled. More...
std::list< InPort * >	getSetOfInPort () const
std::list< OutPort * >	getSetOfOutPort () const
virtual std::set< InputPort * >	edGetSetOfUnitializedInputPort () const
	Becomes deprecated soon. Replaced by ComposedNode::CheckConsistency. More...
virtual bool	edAreAllInputPortInitialized () const
	Becomes deprecated soon. Replaced by ComposedNode::CheckConsistency. More...
InPort *	getInPort (const std::string &name) const throw (Exception)
InPropertyPort *	getInPropertyPort () const throw (Exception)
virtual OutPort *	getOutPort (const std::string &name) const throw (Exception)
std::list< ComposedNode * >	getAllAscendanceOf (ComposedNode *levelToStop=0) const
bool	operator> (const Node &other) const
bool	operator< (const Node &other) const
std::string	getImplementation () const
virtual 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 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	execute ()=0
virtual	~Task ()

Protected Member Functions
	InlineFuncNode (const InlineFuncNode &other, ComposedNode *father)
	InlineFuncNode (const std::string &name)
Protected Member Functions inherited from YACS::ENGINE::InlineNode
	InlineNode (const InlineNode &other, ComposedNode *father)
	InlineNode (const std::string &name)
Protected Member Functions inherited from YACS::ENGINE::ElementaryNode
	ElementaryNode (const std::string &name)
	ElementaryNode (const ElementaryNode &other, ComposedNode *father)
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 throw (Exception)
template<class PORT , class ENUMTYPE >
PORT *	edAddPort (const std::string &portName, std::list< PORT * > &setOfPorts, ENUMTYPE type) throw (Exception)
template<class PORT , class ENUMTYPE >
bool	edCheckAddPort (const std::string &portName, std::list< PORT * > &setOfPorts, ENUMTYPE type) throw (Exception)
Protected Member Functions inherited from YACS::ENGINE::Node
	Node (const std::string &name)
	Node (const Node &other, ComposedNode *father)
virtual Node *	simpleClone (ComposedNode *father, bool editionOnly=true) const =0
virtual void	exForwardFailed ()
virtual void	exForwardFinished ()

Protected Attributes
std::string	_fname
Protected Attributes inherited from YACS::ENGINE::InlineNode
std::string	_script
std::string	_mode
Container *	_container
Protected Attributes inherited from YACS::ENGINE::ElementaryNode
std::list< InputPort * >	_setOfInputPort
std::list< OutputPort * >	_setOfOutputPort
std::list< InputDataStreamPort * >	_setOfInputDataStreamPort
std::list< OutputDataStreamPort * >	_setOfOutputDataStreamPort
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

Additional Inherited Members
Static Public Member Functions inherited from YACS::ENGINE::Node
static std::string	getStateName (YACS::StatesForNode state)
	Return the name of a state. More...
Public Attributes inherited from YACS::ENGINE::Node
YACS::Colour	_colour
Static Public Attributes inherited from YACS::ENGINE::InlineNode
static const char	LOCAL_STR [] ="local"
static const char	REMOTE_STR [] ="remote"
Static Protected Member Functions inherited from YACS::ENGINE::ElementaryNode
template<class PORT >
static void	edRemovePortTypedFromSet (PORT *port, std::list< PORT * > &setOfPorts) throw (Exception)
template<class PORT >
static bool	isPortNameAlreadyExist (const std::string &portName, const std::list< PORT * > &setOfPorts)
Static Protected Attributes inherited from YACS::ENGINE::Node
static const char	SEP_CHAR_IN_PORT [] ="."
static int	_total = 0

Detailed Description

Class for calculation node (function) inlined (and executed) in the schema.

This node is like a function. It can have a state. The first time the node is executed, the string _script is executed in a clean context followed by the execution of the function _fname. Next times, the function _fname is executed within the preserved context.

See Also

ServiceNode

ElementaryNode

Definition at line 92 of file InlineNode.hxx.

Constructor & Destructor Documentation

YACS::ENGINE::InlineFuncNode::InlineFuncNode ( const InlineFuncNode &  other, ComposedNode *  father  )

inlineprotected

Definition at line 95 of file InlineNode.hxx.

        :InlineNode(other,father),_fname(other._fname) { }

YACS::ENGINE::InlineFuncNode::InlineFuncNode ( const std::string &  name )

inlineprotected

Definition at line 97 of file InlineNode.hxx.

:InlineNode(name) { }

InlineFuncNode::~InlineFuncNode ( )

virtual

Definition at line 57 of file InlineNode.cxx.

{
}

Member Function Documentation

void InlineFuncNode::accept ( Visitor *  visitor )

virtual

Reimplemented from YACS::ENGINE::InlineNode.

Reimplemented in YACS::ENGINE::ServerNode.

Definition at line 61 of file InlineNode.cxx.

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

{
  visitor->visitInlineFuncNode(this);
}

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

virtual

Reimplemented from YACS::ENGINE::ElementaryNode.

Reimplemented in YACS::ENGINE::PyFuncNode.

Definition at line 75 of file InlineNode.cxx.

References YACS::ENGINE::ElementaryNode::checkBasicConsistency().

Referenced by YACS::ENGINE::PyFuncNode::checkBasicConsistency().

{
  InlineNode::checkBasicConsistency();
  if(_fname.empty() )
     {
       string mess = "Function name is not defined";
       throw Exception(mess);
     }
}

virtual std::string YACS::ENGINE::InlineFuncNode::getFname ( )

inlinevirtual

Definition at line 101 of file InlineNode.hxx.

Referenced by YACS::HMI::EditionPyFunc::EditionPyFunc(), YACS::ENGINE::DistributedPythonNode::execute(), YACS::ENGINE::PyFuncNode::executeRemote(), YACS::ENGINE::VisitorSaveSchema::visitInlineFuncNode(), and YACS::ENGINE::VisitorSaveSchema::visitServerNode().

{ return _fname; }

void InlineFuncNode::setFname ( const std::string &  fname )

virtual

Set the function name to use in node execution.

Parameters

fname,:

name of the function contained in the script to execute

Definition at line 69 of file InlineNode.cxx.

Referenced by YACS::ENGINE::PyFuncNode::cloneNode(), YACS::remotetypeParser< T >::function(), and YACS::inlinetypeParser< T >::function().

{
  _fname=fname;
  modified();
}

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

inlinevirtual

Reimplemented from YACS::ENGINE::InlineNode.

Reimplemented in YACS::ENGINE::PyFuncNode, YACS::ENGINE::DistributedPythonNode, and YACS::ENGINE::ServerNode.

Definition at line 104 of file InlineNode.hxx.

{ return "YACS__ENGINE__InlineFuncNode"; }

Member Data Documentation

std::string YACS::ENGINE::InlineFuncNode::_fname

protected

Definition at line 107 of file InlineNode.hxx.

Referenced by YACS::ENGINE::PyFuncNode::cloneNode(), and YACS::ENGINE::PyFuncNode::loadLocal().

---

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

• src/engine/InlineNode.hxx
• src/engine/InlineNode.cxx