1 // Copyright (C) 2006-2015 CEA/DEN, EDF R&D
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #ifndef __COMPOSEDNODE_HXX__
21 #define __COMPOSEDNODE_HXX__
23 #include "YACSlibEngineExport.hxx"
25 #include "Scheduler.hxx"
42 class YACSLIBENGINE_EXPORT ComposedNode : public Node, public Scheduler
47 friend class ElementaryNode;
49 static const char SEP_CHAR_BTW_LEVEL[];
51 ComposedNode(const std::string& name);
52 ComposedNode(const ComposedNode& other, ComposedNode *father);
53 void performDuplicationOfPlacement(const Node& other);
54 void performShallowDuplicationOfPlacement(const Node& other);
56 virtual ~ComposedNode();
58 void init(bool start=true);
59 virtual void shutdown(int level);
60 virtual void resetState(int level);
61 std::string getName() const;
62 std::string getTaskName(Task *task) const;
63 DeploymentTree getDeploymentTree() const;
64 DeploymentTree checkDeploymentTree(bool deep) const throw(Exception);
65 std::vector<Task *> getNextTasks(bool& isMore);
66 virtual bool isPlacementPredictableB4Run() const = 0;
67 void notifyFrom(const Task *sender, YACS::Event event, const Executor *execInst);
68 bool edAddLink(OutPort *start, InPort *end) throw(Exception);
69 virtual bool edAddDFLink(OutPort *start, InPort *end) throw(Exception);
70 //Node* DISOWNnode is a SWIG notation to indicate that the ownership of the node is transfered to C++
71 virtual bool edAddChild(Node *DISOWNnode) throw(Exception);
72 virtual void edRemoveChild(Node *node) throw(Exception);
73 bool edAddLink(OutGate *start, InGate *end) throw(Exception);
74 bool edAddCFLink(Node *nodeS, Node *nodeE) throw(Exception);
75 void edRemoveCFLink(Node *nodeS, Node *nodeE) throw(Exception);
76 void edRemoveLink(OutPort *start, InPort *end) throw(Exception);
77 void edRemoveLink(OutGate *start, InGate *end) throw(Exception);
78 virtual bool isRepeatedUnpredictablySeveralTimes() const { return false; }
79 virtual std::list<Node *> edGetDirectDescendants() const = 0;
80 std::list<ElementaryNode *> getRecursiveConstituents() const;
81 std::list<Node *> getAllRecursiveNodes();
82 virtual std::list<Node *> getAllRecursiveConstituents(); // first implementation
83 std::list<ProgressWeight> getProgressWeight() const;
84 std::string getInPortName(const InPort *) const throw (Exception);
85 std::string getOutPortName(const OutPort *) const throw (Exception);
87 int getNumberOfInputPorts() const;
88 int getNumberOfOutputPorts() const;
89 std::list<InputPort *> getSetOfInputPort() const;
90 std::list<OutputPort *> getSetOfOutputPort() const;
91 std::list<InputPort *> getLocalInputPorts() const;
92 std::list<OutputPort *> getLocalOutputPorts() const;
93 std::set<OutPort *> getAllOutPortsLeavingCurrentScope() const;
94 std::set<InPort *> getAllInPortsComingFromOutsideOfCurrentScope() const;
95 std::list<InputDataStreamPort *> getSetOfInputDataStreamPort() const;
96 std::list<OutputDataStreamPort *> getSetOfOutputDataStreamPort() const;
97 OutPort *getOutPort(const std::string& name) const throw(Exception);
98 InputPort *getInputPort(const std::string& name) const throw(Exception);
99 OutputPort *getOutputPort(const std::string& name) const throw(Exception);
100 InputDataStreamPort *getInputDataStreamPort(const std::string& name) const throw(Exception);
101 OutputDataStreamPort *getOutputDataStreamPort(const std::string& name) const throw(Exception);
102 std::vector< std::pair<OutPort *, InPort *> > getSetOfInternalLinks() const;
103 virtual std::vector< std::pair<OutPort *, InPort *> > getSetOfLinksLeavingCurrentScope() const;
104 void checkConsistency(LinkInfo& info) const throw(Exception);
105 virtual std::vector< std::pair<InPort *, OutPort *> > getSetOfLinksComingInCurrentScope() const;
106 virtual std::string typeName() {return "YACS__ENGINE__ComposedNode";}
107 virtual void edUpdateState();
108 virtual void checkBasicConsistency() const throw(Exception);
109 virtual std::string getErrorReport();
111 ComposedNode *getRootNode() const throw(Exception);
112 bool isNodeAlreadyAggregated(const Node *node) const;
113 virtual bool isNameAlreadyUsed(const std::string& name) const;
114 Node *isInMyDescendance(Node *nodeToTest) const;
115 std::string getChildName(const Node* node) const throw(Exception);
116 virtual std::string getMyQualifiedName(const Node *directSon) const;
117 Node *getChildByName(const std::string& name) const throw(Exception);
118 static ComposedNode *getLowestCommonAncestor(Node *node1, Node *node2) throw(Exception);
119 static std::string getLowestCommonAncestorStr(const std::string& node1, const std::string& node2);
122 void accept(Visitor *visitor);
123 virtual void cleanNodes();
124 virtual std::string getProgress() const { return "0"; }
128 bool operator()(ComposedNode *n1, ComposedNode *n2) const
134 void edDisconnectAllLinksWithMe();
135 static bool splitNamesBySep(const std::string& globalName, const char separator[],
136 std::string& firstPart, std::string& lastPart, bool priority) throw(Exception);
137 virtual Node *getChildByShortName(const std::string& name) const throw(Exception) = 0;
138 YACS::Event updateStateFrom(Node *node, YACS::Event event, const Executor *execInst);//update the state of this. Precondition : node->_father == this
139 virtual YACS::Event updateStateOnStartEventFrom(Node *node);//transition 3 doc P.R
140 virtual YACS::Event updateStateOnFinishedEventFrom(Node *node) = 0;//transition 9 doc P.R.
141 virtual YACS::Event updateStateOnFailedEventFrom(Node *node, const Executor *execInst);//transition 9 doc P.R.
142 virtual void checkLinkPossibility(OutPort *start, const std::list<ComposedNode *>& pointsOfViewStart,
143 InPort *end, const std::list<ComposedNode *>& pointsOfViewEnd) throw(Exception);
144 virtual void buildDelegateOf(InPort * & port, OutPort *initialStart, const std::list<ComposedNode *>& pointsOfView);
145 virtual void buildDelegateOf(std::pair<OutPort *, OutPort *>& port, InPort *finalTarget, const std::list<ComposedNode *>& pointsOfView);
146 virtual void getDelegateOf(InPort * & port, OutPort *initialStart, const std::list<ComposedNode *>& pointsOfView) throw(Exception);
147 virtual void getDelegateOf(std::pair<OutPort *, OutPort *>& port, InPort *finalTarget, const std::list<ComposedNode *>& pointsOfView) throw(Exception);
148 virtual void releaseDelegateOf(InPort * & port, OutPort *initialStart, const std::list<ComposedNode *>& pointsOfView) throw(Exception);
149 virtual void releaseDelegateOf(OutPort *portDwn, OutPort *portUp, InPort *finalTarget, const std::list<ComposedNode *>& pointsOfView) throw(Exception);
150 virtual void checkNoCyclePassingThrough(Node *node) throw(Exception) = 0;
151 void checkInMyDescendance(Node *nodeToTest) const throw(Exception);
152 template <class PORT>
153 std::string getPortName(const PORT * port) const throw (Exception);
154 //For CF Computations
155 void checkNoCrossHierachyWith(Node *node) const throw (Exception);
156 virtual void performCFComputations(LinkInfo& info) const;
157 virtual void destructCFComputations(LinkInfo& info) const;
158 Node *getLowestNodeDealingAll(const std::list<OutPort *>& ports) const;
159 void checkLinksCoherenceRegardingControl(const std::vector<OutPort *>& starts,
160 InputPort *end, LinkInfo& info) const throw(Exception);
161 virtual void checkControlDependancy(OutPort *start, InPort *end, bool cross,
162 std::map < ComposedNode *, std::list < OutPort * >, SortHierarc >& fw,
163 std::vector<OutPort *>& fwCross,
164 std::map< ComposedNode *, std::list < OutPort *>, SortHierarc >& bw,
165 LinkInfo& info) const = 0;
166 void solveObviousOrDelegateCFLinks(const std::list<OutPort *>& starts, InputPort *end, unsigned char& alreadyFed, bool direction, LinkInfo& info) const;
167 virtual void checkCFLinks(const std::list<OutPort *>& starts, InputPort *end, unsigned char& alreadyFed, bool direction, LinkInfo& info) const;
169 //For internal calculations.
170 static const unsigned char FED_ST = 2;
171 static const unsigned char FREE_ST = 0;
172 static const unsigned char FED_DS_ST = 1;
175 template <class PORT>
176 std::string ComposedNode::getPortName(const PORT * port) const throw (Exception)
178 Node *node = port->getNode();
179 std::string portName = port->getName();
180 checkInMyDescendance(node);
182 while (father != this)
184 portName = father->getQualifiedName() + Node::SEP_CHAR_IN_PORT + portName;
185 father = father->_father;