YACS::ENGINE::DataNode Class Reference
Class for data parameters specification. More...
#include <DataNode.hxx>
Inheritance diagram for YACS::ENGINE::DataNode:
Collaboration diagram for YACS::ENGINE::DataNode:
Public Member Functions | |
| virtual void | setData (InputPort *port, const std::string &data) |
| virtual void | setData (OutputPort *port, const std::string &data) |
| virtual void | setRef (const std::string &ref) |
| virtual std::string | getRef () |
| virtual | ~DataNode () |
| virtual std::string | typeName () |
 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) 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) |
| virtual void | checkBasicConsistency () 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... | |
| 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 | load () |
| virtual void | getCoupledTasks (std::set< Task * > &coupledSet) |
| Calls getCoupledNodes for Task interface. More... | |
| virtual void | getCoupledNodes (std::set< Task * > &coupledSet) |
| Put all nodes that are coupled to this node in coupledSet. More... | |
| void | accept (Visitor *visitor) |
| virtual void | addDatastreamPortToInitMultiService (const std::string &port_name, int number) |
| 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 | |
| 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 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 | _ref |
| 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::Node | |
| static std::map< int, Node * > | idMap |
| 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 data parameters specification.
Definition at line 37 of file DataNode.hxx.
Constructor & Destructor Documentation
|
inlineprotected |
Definition at line 40 of file DataNode.hxx.
|
inlineprotected |
Definition at line 42 of file DataNode.hxx.
|
virtual |
Definition at line 26 of file DataNode.cxx.
Member Function Documentation
|
virtual |
Definition at line 39 of file DataNode.cxx.
References _ref.
Referenced by YACS::ENGINE::VisitorSaveSalomeSchema::visitOutNode(), YACS::ENGINE::VisitorSaveSalomeSchema::visitPresetNode(), YACS::ENGINE::VisitorSaveSalomeSchema::visitStudyInNode(), and YACS::ENGINE::VisitorSaveSalomeSchema::visitStudyOutNode().
|
virtual |
Reimplemented in YACS::ENGINE::StudyOutNode, and YACS::ENGINE::OutNode.
Definition at line 29 of file DataNode.cxx.
Referenced by YACS::HMI::CommandSetInPortValue::localExecute(), YACS::HMI::CommandSetOutPortValue::localExecute(), YACS::HMI::CommandSetInPortValue::localReverse(), and YACS::HMI::CommandSetOutPortValue::localReverse().
|
virtual |
Reimplemented in YACS::ENGINE::PresetNode, and YACS::ENGINE::StudyInNode.
Definition at line 32 of file DataNode.cxx.
|
virtual |
Definition at line 35 of file DataNode.cxx.
References _ref, and gui.CONNECTOR::ref().
|
inlinevirtual |
Reimplemented from YACS::ENGINE::ElementaryNode.
Reimplemented in YACS::ENGINE::StudyOutNode, YACS::ENGINE::PresetNode, and YACS::ENGINE::StudyInNode.
Definition at line 49 of file DataNode.hxx.
Member Data Documentation
|
protected |
Definition at line 51 of file DataNode.hxx.
Referenced by YACS::ENGINE::OutNode::execute(), YACS::ENGINE::StudyOutNode::execute(), getRef(), and setRef().
The documentation for this class was generated from the following files:
- src/engine/DataNode.hxx
- src/engine/DataNode.cxx