Salome HOME
Squeeze memory of process hosting YACS graph
[modules/yacs.git] / src / engine / InPort.hxx
1 // Copyright (C) 2006-2019  CEA/DEN, EDF R&D
2 //
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.
7 //
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.
12 //
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
16 //
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
18 //
19
20 #ifndef __INPORT_HXX__
21 #define __INPORT_HXX__
22
23 #include "YACSlibEngineExport.hxx"
24 #include "DataPort.hxx"
25
26 #include <set>
27
28 namespace YACS
29 {
30   namespace ENGINE
31   {
32     class Loop;
33     class OutPort;
34     class ProxyPort;
35     class OutputPort;
36     class DynParaLoop;
37     class ForEachLoop;
38     class SplitterNode;
39     class ComposedNode;
40     class OptimizerLoop;
41     class ElementaryNode;
42     class CollectorSwOutPort;
43     class OutputDataStreamPort;
44     class InterceptorInputPort;
45
46     class YACSLIBENGINE_EXPORT InPort : public virtual DataPort
47     {
48       friend class Loop;
49       friend class OutPort;
50       friend class ProxyPort;
51       friend class OutputPort;
52       friend class DynParaLoop;
53       friend class ForEachLoop;
54       friend class SplitterNode;
55       friend class ComposedNode;
56       friend class OptimizerLoop;
57       friend class ElementaryNode; //for removeAllLinksWithMe
58       friend class CollectorSwOutPort;
59       friend class OutputDataStreamPort;
60       friend class InterceptorInputPort;
61     public:
62       virtual InPort *getPublicRepresentant() { return this; }
63       virtual int edGetNumberOfLinks() const;
64       virtual std::set<OutPort *> edSetOutPort() const;
65       bool canSafelySqueezeMemory() const;
66       bool isBackLinked() const { return !_backLinks.empty(); }
67       virtual ~InPort();
68       virtual std::string typeName() {return "YACS__ENGINE__InPort";}
69     protected:
70       InPort(const InPort& other, Node *newHelder);
71       InPort(const std::string& name, Node *node, TypeCode* type);
72       void edRemoveAllLinksLinkedWithMe() throw(Exception);
73       virtual void edNotifyReferencedBy(OutPort *fromPort, bool isLoopProof = true);
74       virtual void edNotifyDereferencedBy(OutPort *fromPort);
75       virtual void getAllRepresentants(std::set<InPort *>& repr) const;
76     protected:
77       std::set< std::pair<OutPort *,bool> > _backLinks;
78     };
79   }
80 }
81
82 #endif