Version: 8.3.0
YACS::ENGINE::DSToDFForLoop Class Reference

#include <Loop.hxx>

Inheritance diagram for YACS::ENGINE::DSToDFForLoop:
Collaboration diagram for YACS::ENGINE::DSToDFForLoop:

Public Member Functions

 ~DSToDFForLoop ()
 
- 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
 
ComponentInstancegetComponent ()
 
const ComponentInstancegetComponent () const
 
ContainergetContainer ()
 
YACS::StatesForNode getState () const
 
void edRemovePort (Port *port) throw (Exception)
 
std::list< ElementaryNode * > getRecursiveConstituents () const
 
std::list< ProgressWeightgetProgressWeight () const
 Get the progress weight for all elementary nodes. More...
 
NodegetChildByName (const std::string &name) const throw (Exception)
 
virtual void checkBasicConsistency () const throw (Exception)
 
ComposedNodegetDynClonerIfExists (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)
 
InputPortgetInputPort (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
 
OutputDataStreamPortgetOutputDataStreamPort (const std::string &name) const throw (Exception)
 
virtual InputPortcreateInputPort (const std::string &inputPortName, TypeCode *type)
 
virtual OutputPortcreateOutputPort (const std::string &outputPortName, TypeCode *type)
 
virtual InputDataStreamPortcreateInputDataStreamPort (const std::string &inputPortDSName, TypeCode *type)
 
virtual OutputDataStreamPortcreateOutputDataStreamPort (const std::string &outputPortDSName, TypeCode *type)
 
virtual InputPortedAddInputPort (const std::string &inputPortName, TypeCode *type) throw (Exception)
 
virtual OutputPortedAddOutputPort (const std::string &outputPortName, TypeCode *type) throw (Exception)
 
virtual InputDataStreamPortedAddInputDataStreamPort (const std::string &inputPortDSName, TypeCode *type) throw (Exception)
 
virtual OutputDataStreamPortedAddOutputDataStreamPort (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 std::string typeName ()
 
virtual void edUpdateState ()
 update the status of the node More...
 
virtual void ensureLoading ()
 Put this node into TOLOAD state when possible. More...
 
int getMaxLevelOfParallelism () const
 
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 getCoupledTasks (std::set< Task * > &coupledSet)
 Calls getCoupledNodes for Task interface. More...
 
virtual void getCoupledNodes (std::set< Task * > &coupledSet)
 Put all nodes that are coupled to this node in coupledSet. More...
 
void accept (Visitor *visitor)
 
virtual void addDatastreamPortToInitMultiService (const std::string &port_name, int number)
 
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...
 
Nodeclone (ComposedNode *father, bool editionOnly=true) const
 This method MUST NEVER BE VIRTUAL More...
 
NodecloneWithoutCompAndContDeepCpy (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...
 
InGategetInGate ()
 
OutGategetOutGate ()
 
const std::string & getName () const
 
void setName (const std::string &name)
 Change the name of the node. More...
 
ComposedNodegetFather () 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...
 
InPortgetInPort (const std::string &name) const throw (Exception)
 
InPropertyPortgetInPropertyPort () const throw (Exception)
 
virtual OutPortgetOutPort (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 ComposedNodegetRootNode () 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 ProcgetProc ()
 
virtual const ProcgetProc () 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 ~Task ()
 

Private Member Functions

 DSToDFForLoop (Loop *loop, const std::string &name, TypeCode *type)
 
NodesimpleClone (ComposedNode *father, bool editionOnly=true) const
 
void loopHasOneMoreRef ()
 
bool loopHasOneLessRef ()
 
void getReadyTasks (std::vector< Task * > &tasks)
 
OutputPortgetOutputPort (const std::string &name) const throw (Exception)
 
InputDataStreamPortgetInputDataStreamPort (const std::string &name) const throw (Exception)
 
void execute ()
 
void load ()
 

Private Attributes

int _nbOfTimeUsed
 
Loop_loopArtificiallyBuiltMe
 

Friends

class Loop
 

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::Node
static std::map< int, Node * > idMap
 
- Protected Member Functions inherited from YACS::ENGINE::ElementaryNode
 ElementaryNode (const std::string &name)
 
 ElementaryNode (const ElementaryNode &other, ComposedNode *father)
 
void performDuplicationOfPlacement (const Node &other)
 performs a duplication of placement using clone method of containers and components. clone behaviour is driven by attachOnCloning attribute. More...
 
void performShallowDuplicationOfPlacement (const Node &other)
 performs a also duplication of placement but here containers and components are not copied at all whatever the value of attachedOnCloning. More...
 
void initCommonPartWithoutStateManagement (bool start)
 
virtual void createMultiDatastreamPorts ()
 
void edDisconnectAllLinksWithMe ()
 
bool areAllInputPortsValid () const
 
template<class PORT >
PORT * getPort (const std::string &name, const std::list< PORT * > &setOfPorts) const 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)
 
- 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)
 
- 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
 
- Static Protected Attributes inherited from YACS::ENGINE::Node
static const char SEP_CHAR_IN_PORT [] ="."
 
static int _total = 0
 

Detailed Description

Definition at line 98 of file Loop.hxx.

Constructor & Destructor Documentation

DSToDFForLoop::DSToDFForLoop ( Loop loop,
const std::string &  name,
TypeCode type 
)
private

Definition at line 202 of file Loop.cxx.

References YACS::ENGINE::Node::_father, YACS::ENGINE::Node::_name, YACS::ENGINE::ElementaryNode::_setOfInputDataStreamPort, YACS::ENGINE::ElementaryNode::_setOfOutputPort, and YACS::ENGINE::ComposedNode::getName().

203 {
204  _name="DS2DF For "; _name+=loop->getName(); _name+=" representing port "; _name+=name;
205  _father=loop;
206  _setOfOutputPort.push_back(new OutputPort4DS2DF(this,type));
207  _setOfInputDataStreamPort.push_back(new InputDataStreamPort4DS2DF(this,type));
208 }
DSToDFForLoop::~DSToDFForLoop ( )

Definition at line 215 of file Loop.cxx.

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

216 {
218 }

Member Function Documentation

void DSToDFForLoop::execute ( )
privatevirtual

Implements YACS::ENGINE::Task.

Definition at line 240 of file Loop.cxx.

241 {
242  //TO IMPLEMENT
243 }
InputDataStreamPort * DSToDFForLoop::getInputDataStreamPort ( const std::string &  name) const throw (Exception)
privatevirtual

Reimplemented from YACS::ENGINE::ElementaryNode.

Definition at line 230 of file Loop.cxx.

231 {
232  list<InputDataStreamPort *>::const_iterator it = _setOfInputDataStreamPort.begin();
233  return (*it);
234 }
OutputPort * DSToDFForLoop::getOutputPort ( const std::string &  name) const throw (Exception)
privatevirtual

Reimplemented from YACS::ENGINE::ElementaryNode.

Definition at line 224 of file Loop.cxx.

225 {
226  list<OutputPort *>::const_iterator it = _setOfOutputPort.begin();
227  return (*it);
228 }
void DSToDFForLoop::getReadyTasks ( std::vector< Task * > &  tasks)
privatevirtual

add this node task to a given set of ready tasks, if this task is ready to activate

Reimplemented from YACS::ENGINE::ElementaryNode.

Definition at line 220 of file Loop.cxx.

221 {
222 }
void DSToDFForLoop::load ( )
privatevirtual

Reimplemented from YACS::ENGINE::ElementaryNode.

Definition at line 236 of file Loop.cxx.

237 {
238 }
bool YACS::ENGINE::DSToDFForLoop::loopHasOneLessRef ( )
inlineprivate

Definition at line 108 of file Loop.hxx.

References _nbOfTimeUsed.

108 { return --_nbOfTimeUsed==0; }
void YACS::ENGINE::DSToDFForLoop::loopHasOneMoreRef ( )
inlineprivate

Definition at line 107 of file Loop.hxx.

References _nbOfTimeUsed.

107 { _nbOfTimeUsed++; }
Node * DSToDFForLoop::simpleClone ( ComposedNode father,
bool  editionOnly = true 
) const
privatevirtual

Implements YACS::ENGINE::Node.

Definition at line 210 of file Loop.cxx.

211 {
212  throw Exception("DSToDFForLoop::simpleClone : Internal error");
213 }

Friends And Related Function Documentation

friend class Loop
friend

Definition at line 100 of file Loop.hxx.

Member Data Documentation

Loop* YACS::ENGINE::DSToDFForLoop::_loopArtificiallyBuiltMe
private

Definition at line 103 of file Loop.hxx.

int YACS::ENGINE::DSToDFForLoop::_nbOfTimeUsed
private

Definition at line 102 of file Loop.hxx.

Referenced by loopHasOneLessRef(), and loopHasOneMoreRef().


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