1 // Copyright (C) 2006-2022 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 __CONTAINER_HXX__
21 #define __CONTAINER_HXX__
23 #include "YACSlibEngineExport.hxx"
24 #include "Exception.hxx"
25 #include "RefCounter.hxx"
34 class ComponentInstance;
38 * This is an abstract class, that represents an abstract process in which ComponentInstances can be launched and run.
39 * An instance of this will be mapped to one and only one physical container (except in the foreach context)
41 class YACSLIBENGINE_EXPORT Container : public RefCounter
49 virtual std::string getKind() const = 0;
50 //Execution only methods
51 virtual std::string getDiscreminantStrOfThis(const Task *askingNode) const;
52 virtual bool isAlreadyStarted(const Task *askingNode) const = 0;
53 virtual void start(const Task *askingNode) = 0;
54 virtual void start(const Task *askingNode,
55 const std::string& resource_name,
56 const std::string& container_name);
57 virtual bool canAcceptImposedResource();
58 virtual bool isUsingPythonCache();
59 virtual void usePythonCache(bool v);
60 virtual std::string getPlacementId(const Task *askingNode) const = 0;
61 virtual std::string getFullPlacementId(const Task *askingNode) const = 0;
62 //Edition only methods
63 virtual void setAttachOnCloningStatus(bool val) const;
64 virtual void attachOnCloning() const;
65 virtual void dettachOnCloning() const;
66 virtual bool isAttachedOnCloning() const;
67 virtual void lock() = 0;
68 virtual void unLock() = 0;
69 //! \b WARNING ! clone behaviour \b MUST be in coherence with what is returned by isAttachedOnCloning() method
70 virtual Container *clone() const = 0;
71 virtual Container *cloneAlways() const = 0;
72 virtual bool isSupportingRTODefNbOfComp() const;
73 virtual void checkCapabilityToDealWith(const ComponentInstance *inst) const = 0;
74 virtual void setProperty(const std::string& name,const std::string& value) = 0;
75 virtual std::string getProperty(const std::string& name) const = 0;
76 virtual void clearProperties() = 0;
77 virtual void addComponentName(const std::string& name) = 0;
78 virtual std::map<std::string,std::string> getProperties() const = 0;
79 virtual std::map<std::string,std::string> getResourceProperties(const std::string& name) const = 0;
80 virtual void setProperties(const std::map<std::string,std::string>& properties);
81 virtual std::string getName() const { return _name; }
82 //! \b WARNING ! name is used in edition to identify different containers, it is not the runtime name of the container
83 void setName(std::string name) { _name = name; }
84 void setProc(Proc* proc) { _proc = proc; }
85 Proc* getProc() { return _proc; }
86 virtual void shutdown(int level) = 0;
87 static const char KIND_ENTRY[];
88 static const char AOC_ENTRY[];
89 static const char USE_PYCACHE_PROPERTY[];
92 mutable bool _isAttachedOnCloning;