YACS::ENGINE::StudyInNode Class Reference

#include <StudyNodes.hxx>

Inheritance diagram for YACS::ENGINE::StudyInNode:

Collaboration diagram for YACS::ENGINE::StudyInNode:

Public Member Functions
	StudyInNode (const std::string &name)
	StudyInNode (const StudyInNode &other, ComposedNode *father)
virtual void	execute ()
virtual void	accept (Visitor *visitor)
virtual void	checkBasicConsistency () const
virtual void	setData (OutputPort *port, const std::string &data)
virtual OutputPort *	createOutputPort (const std::string &outputPortName, TypeCode *type)
virtual std::string	typeName ()
Public Member Functions inherited from YACS::ENGINE::DataNode
virtual void	setData (InputPort *port, const std::string &data)
virtual void	setRef (const std::string &ref)
virtual std::string	getRef ()
virtual	~DataNode ()
Public Member Functions inherited from YACS::ENGINE::ElementaryNode
virtual	~ElementaryNode ()
void	exUpdateState ()
	Update the node state. More...
void	init (bool start=true)
bool	isDeployable () const
ComponentInstance *	getComponent ()
const ComponentInstance *	getComponent () const
Container *	getContainer ()
YACS::StatesForNode	getState () const
void	getReadyTasks (std::vector< Task * > &tasks)
void	edRemovePort (Port *port)
std::list< ElementaryNode * >	getRecursiveConstituents () const
std::list< ProgressWeight >	getProgressWeight () const
	Get the progress weight for all elementary nodes. More...
Node *	getChildByName (const std::string &name) const
ComposedNode *	getDynClonerIfExists (const ComposedNode *levelToStop) const
int	getNumberOfInputPorts () const
int	getNumberOfOutputPorts () const
std::string	getInPortName (const InPort *) const
std::string	getOutPortName (const OutPort *) const
InputPort *	getInputPort (const std::string &name) const
OutputPort *	getOutputPort (const std::string &name) const
std::list< InputPort * >	getSetOfInputPort () const
std::list< OutputPort * >	getSetOfOutputPort () const
std::list< InputPort * >	getLocalInputPorts () const
std::list< OutputPort * >	getLocalOutputPorts () const
std::set< OutPort * >	getAllOutPortsLeavingCurrentScope () const
std::set< InPort * >	getAllInPortsComingFromOutsideOfCurrentScope () const
virtual std::vector< std::pair< OutPort *, InPort * > >	getSetOfLinksLeavingCurrentScope () const
virtual std::vector< std::pair< InPort *, OutPort * > >	getSetOfLinksComingInCurrentScope () const
std::list< InputDataStreamPort * >	getSetOfInputDataStreamPort () const
std::list< OutputDataStreamPort * >	getSetOfOutputDataStreamPort () const
InputDataStreamPort *	getInputDataStreamPort (const std::string &name) const
OutputDataStreamPort *	getOutputDataStreamPort (const std::string &name) const
virtual InputPort *	createInputPort (const std::string &inputPortName, TypeCode *type)
virtual InputDataStreamPort *	createInputDataStreamPort (const std::string &inputPortDSName, TypeCode *type)
virtual OutputDataStreamPort *	createOutputDataStreamPort (const std::string &outputPortDSName, TypeCode *type)
virtual InputPort *	edAddInputPort (const std::string &inputPortName, TypeCode *type)
virtual OutputPort *	edAddOutputPort (const std::string &outputPortName, TypeCode *type)
virtual InputDataStreamPort *	edAddInputDataStreamPort (const std::string &inputPortDSName, TypeCode *type)
virtual OutputDataStreamPort *	edAddOutputDataStreamPort (const std::string &outputPortDSName, TypeCode *type)
virtual void	edOrderInputPorts (const std::list< InputPort * > &ports)
virtual void	edOrderOutputPorts (const std::list< OutputPort * > &ports)
virtual void	edUpdateState ()
	update the status of the node More...
virtual void	ensureLoading ()
	Put this node into TOLOAD state when possible. More...
int	getMaxLevelOfParallelism () const
ComplexWeight *	getWeight ()
void	setWeight (double elementaryWeight)
void	getWeightRegardingDPL (ComplexWeight *weight)
void	partitionRegardingDPL (const PartDefinition *pd, std::map< ComposedNode *, YACS::BASES::AutoRefCnt< PartDefinition > > &zeMap)
void	begin ()
bool	isReady ()
void	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)
Public Member Functions inherited from YACS::ENGINE::Node
virtual	~Node ()
virtual void	shutdown (int level)
	Stop all pending activities of the node. More...
virtual void	resetState (int level)
	Reset the node state depending on the parameter level. More...
Node *	clone (ComposedNode *father, bool editionOnly=true) const
	This method MUST NEVER BE VIRTUAL More...
Node *	cloneWithoutCompAndContDeepCpy (ComposedNode *father, bool editionOnly=true) const
	This method MUST NEVER BE VIRTUAL More...
void	setState (YACS::StatesForNode theState)
	Sets the given state for node. More...
virtual YACS::StatesForNode	getEffectiveState () const
	Return the node state in the context of its father. More...
virtual YACS::StatesForNode	getEffectiveState (const Node *) const
	Return the effective state of a node in the context of this one (its father) More...
std::string	getColorState (YACS::StatesForNode state) const
	Return the color associated to a state. More...
InGate *	getInGate ()
OutGate *	getOutGate ()
const std::string &	getName () const
void	setName (const std::string &name)
	Change the name of the node. More...
ComposedNode *	getFather () const
const std::string	getId () const
bool	exIsControlReady () const
std::list< Node * >	getOutNodes () const
virtual void	writeDot (std::ostream &os) const
	Dump to the input stream a dot representation of the node. More...
void	writeDotInFile (const std::string &fileName) const
virtual void	exFailedState ()
	Notify this node that its execution has failed. More...
virtual void	exDisabledState ()
	Notify this node that it has been disabled. More...
std::list< InPort * >	getSetOfInPort () const
std::list< OutPort * >	getSetOfOutPort () const
virtual std::set< InputPort * >	edGetSetOfUnitializedInputPort () const
	Becomes deprecated soon. Replaced by ComposedNode::CheckConsistency. More...
virtual bool	edAreAllInputPortInitialized () const
	Becomes deprecated soon. Replaced by ComposedNode::CheckConsistency. More...
InPort *	getInPort (const std::string &name) const
InPropertyPort *	getInPropertyPort () const
virtual OutPort *	getOutPort (const std::string &name) const
std::list< ComposedNode * >	getAllAscendanceOf (ComposedNode *levelToStop=0) const
bool	operator> (const Node &other) const
bool	operator< (const Node &other) const
std::string	getImplementation () const
DynParaLoop *	getClosestDPLAmongAncestors () const
virtual ComposedNode *	getRootNode () const
virtual void	setProperty (const std::string &name, const std::string &value)
virtual std::string	getProperty (const std::string &name)
std::map< std::string, std::string >	getProperties ()
std::map< std::string, std::string >	getPropertyMap ()
virtual void	setProperties (std::map< std::string, std::string > properties)
virtual Proc *	getProc ()
virtual const Proc *	getProc () const
std::string	getQualifiedName () const
	same as Node::getName() in most cases, but differs for children of switch More...
int	getNumId ()
	return node instance identifiant, unique for each node instance More...
std::vector< std::pair< std::string, int > >	getDPLScopeInfo (ComposedNode *gfn)
virtual void	applyDPLScope (ComposedNode *gfn)
virtual void	sendEvent (const std::string &event)
	emit notification to all observers registered with the dispatcher More...
virtual void	sendEvent2 (const std::string &event, void *something)
	emit notification to all observers registered with the dispatcher More...
virtual std::string	getErrorDetails () const
virtual void	setErrorDetails (const std::string &error)
virtual void	modified ()
	Sets Node in modified state and its father if it exists. More...
virtual int	isModified ()
virtual int	isValid ()
	indicates if the node is valid (returns 1) or not (returns 0) More...
virtual std::string	getErrorReport ()
	returns a string that contains an error report if the node is in error More...
virtual std::string	getContainerLog ()
	returns a string that contains the name of the container log file if it exists More...
virtual void	cleanNodes ()
	Clean the node in case of not clean exit. More...
Public Member Functions inherited from YACS::ENGINE::Task
virtual void	imposeResource (const std::string &resource_name, const std::string &container_name)
virtual bool	canAcceptImposedResource ()
virtual bool	hasImposedResource () const
virtual	~Task ()

Static Public Attributes
static const char	IMPL_NAME [] ="XML"
Static Public Attributes inherited from YACS::ENGINE::Node
static std::map< int, Node * >	idMap

Protected Member Functions
Node *	simpleClone (ComposedNode *father, bool editionOnly) const
Protected Member Functions inherited from YACS::ENGINE::DataNode
	DataNode (const DataNode &other, ComposedNode *father)
	DataNode (const std::string &name)
Protected Member Functions inherited from YACS::ENGINE::ElementaryNode
	ElementaryNode (const std::string &name)
	ElementaryNode (const ElementaryNode &other, ComposedNode *father)
void	performDuplicationOfPlacement (const Node &other)
	performs a duplication of placement using clone method of containers and components. clone behaviour is driven by attachOnCloning attribute. More...
void	performShallowDuplicationOfPlacement (const Node &other)
	performs a also duplication of placement but here containers and components are not copied at all whatever the value of attachedOnCloning. More...
void	initCommonPartWithoutStateManagement (bool start)
virtual void	createMultiDatastreamPorts ()
void	edDisconnectAllLinksWithMe ()
bool	areAllInputPortsValid () const
template<class PORT >
PORT *	getPort (const std::string &name, const std::list< PORT * > &setOfPorts) const
template<class PORT , class ENUMTYPE >
PORT *	edAddPort (const std::string &portName, std::list< PORT * > &setOfPorts, ENUMTYPE type)
template<class PORT , class ENUMTYPE >
bool	edCheckAddPort (const std::string &portName, std::list< PORT * > &setOfPorts, ENUMTYPE type)
Protected Member Functions inherited from YACS::ENGINE::Node
	Node (const std::string &name)
	Node (const Node &other, ComposedNode *father)
virtual void	exForwardFailed ()
virtual void	exForwardFinished ()

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...
static void	checkValidityOfNodeName (const std::string &name)
Public Attributes inherited from YACS::ENGINE::Node
YACS::Colour	_colour
Static Protected Member Functions inherited from YACS::ENGINE::ElementaryNode
template<class PORT >
static void	edRemovePortTypedFromSet (PORT *port, std::list< PORT * > &setOfPorts)
template<class PORT >
static bool	isPortNameAlreadyExist (const std::string &portName, const std::list< PORT * > &setOfPorts)
Static Protected Member Functions inherited from YACS::ENGINE::Node
static void	checkValidityOfPortName (const std::string &name)
static ComposedNode *	checkHavingCommonFather (Node *node1, Node *node2)
Protected Attributes inherited from YACS::ENGINE::DataNode
std::string	_ref
Protected Attributes inherited from YACS::ENGINE::ElementaryNode
std::list< InputPort * >	_setOfInputPort
std::list< OutputPort * >	_setOfOutputPort
std::list< InputDataStreamPort * >	_setOfInputDataStreamPort
std::list< OutputDataStreamPort * >	_setOfOutputDataStreamPort
ComplexWeight	_weight
bool	_createDatastreamPorts
bool	_multi_port_node
Protected Attributes inherited from YACS::ENGINE::Node
InGate	_inGate
OutGate	_outGate
InPropertyPort *	_inPropertyPort
std::string	_name
ComposedNode *	_father
YACS::StatesForNode	_state
int	_modified
std::string	_errorDetails
int	_numId
std::string	_implementation
std::map< std::string, std::string >	_propertyMap
Node *	_eventReceiver =nullptr
Static Protected Attributes inherited from YACS::ENGINE::Node
static const char	SEP_CHAR_IN_PORT [] ="."
static int	_total = 0

Detailed Description

Definition at line 30 of file StudyNodes.hxx.

Constructor & Destructor Documentation

StudyInNode() [1/2]

YACS::ENGINE::StudyInNode::StudyInNode

(

const std::string &

name

)

Definition at line 48 of file StudyNodes.cxx.

  : DataNode(name)
{
  _implementation=IMPL_NAME;
}

References YACS::ENGINE::Node::_implementation, and IMPL_NAME.

Referenced by simpleClone().

StudyInNode() [2/2]

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

Definition at line 54 of file StudyNodes.cxx.

  : DataNode(other, father)
{
}

Member Function Documentation

accept()

void YACS::ENGINE::StudyInNode::accept ( Visitor *  visitor )

virtual

Reimplemented from YACS::ENGINE::ElementaryNode.

Definition at line 133 of file StudyNodes.cxx.

{
  visitor->visitStudyInNode(this);
}

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

checkBasicConsistency()

void YACS::ENGINE::StudyInNode::checkBasicConsistency ( ) const

virtual

Reimplemented from YACS::ENGINE::ElementaryNode.

Definition at line 96 of file StudyNodes.cxx.

{
  DEBTRACE("StudyInNode::checkBasicConsistency");
  if (! _setOfInputPort.empty())
    {
      std::string what = "StudyNode ";
      what += getName();
      what += " only accepts OutputStudyPort, no InputPort";
      throw Exception(what);
    }
 
  std::list<OutputPort *>::const_iterator iter;
  for(iter=_setOfOutputPort.begin();iter!=_setOfOutputPort.end();iter++)
    {
      OutputStudyPort *inp = dynamic_cast<OutputStudyPort*>(*iter);
      if (!inp)
        {
          std::string what("Output port: ");
          what += (*iter)->getName();
          what += " is not an OutputStudyPort. StudyNode ";
          what += getName();
          what += " only accepts OutputStudyPorts";
          throw Exception(what);
        }
 
      std::string data = inp->getData();
      DEBTRACE(data);
      if (data.empty())
        {
          std::string what("OutputStudyPort: ");
          what += (*iter)->getName();
          what += " is not initialised";
          throw Exception(what);
        }
    }
}

References YACS::ENGINE::ElementaryNode::_setOfInputPort, YACS::ENGINE::ElementaryNode::_setOfOutputPort, DEBTRACE, YACS::ENGINE::OutputStudyPort::getData(), and YACS::ENGINE::Node::getName().

createOutputPort()

OutputPort * YACS::ENGINE::StudyInNode::createOutputPort ( const std::string &  outputPortName, TypeCode *  type  )

virtual

Reimplemented from YACS::ENGINE::ElementaryNode.

Definition at line 64 of file StudyNodes.cxx.

{
  return new OutputStudyPort(outputPortName, this, type);
}

execute()

void YACS::ENGINE::StudyInNode::execute ( )

virtual

Implements YACS::ENGINE::Task.

Definition at line 75 of file StudyNodes.cxx.

{
  DEBTRACE("+++++++ StudyInNode::execute +++++++++++");
 
  std::list<OutputPort *>::const_iterator iter;
  for(iter = _setOfOutputPort.begin(); iter != _setOfOutputPort.end(); iter++)
    {
      OutputStudyPort *outp = dynamic_cast<OutputStudyPort *>(*iter);
      try
        {
          outp->getDataFromStudy();
        }
      catch(Exception& e)
        {
          _errorDetails=e.what();
          throw;
        }
    }
  DEBTRACE("+++++++ end StudyInNode::execute +++++++++++" );
}

References YACS::ENGINE::Node::_errorDetails, YACS::ENGINE::ElementaryNode::_setOfOutputPort, DEBTRACE, YACS::ENGINE::OutputStudyPort::getDataFromStudy(), and YACS::Exception::what().

setData()

void YACS::ENGINE::StudyInNode::setData ( OutputPort *  port, const std::string &  data  )

virtual

Reimplemented from YACS::ENGINE::DataNode.

Definition at line 69 of file StudyNodes.cxx.

{
  OutputStudyPort *outp = dynamic_cast<OutputStudyPort *>(port);
  outp->setData(data);
}

References YACS::ENGINE::OutputStudyPort::setData().

simpleClone()

Node * YACS::ENGINE::StudyInNode::simpleClone ( ComposedNode *  father, bool  editionOnly  ) const

protectedvirtual

Implements YACS::ENGINE::Node.

Definition at line 59 of file StudyNodes.cxx.

{
  return new StudyInNode(*this,father);
}

References StudyInNode().

typeName()

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

inlinevirtual

Reimplemented from YACS::ENGINE::DataNode.

Definition at line 42 of file StudyNodes.hxx.

{return "YACS__ENGINE__StudyInNode";}

Member Data Documentation

IMPL_NAME

const char YACS::ENGINE::StudyInNode::IMPL_NAME ="XML"

static

Definition at line 44 of file StudyNodes.hxx.

Referenced by StudyInNode().

---

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

• src/runtime/StudyNodes.hxx
• src/runtime/StudyNodes.cxx