Salome HOME
updated copyright message
[modules/yacs.git] / src / runtime / SalomeContainerTools.hxx
1 // Copyright (C) 2006-2023  CEA, EDF
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 #pragma once
21
22 #include "YACSRuntimeSALOMEExport.hxx"
23 #include "SALOMEconfig.h"
24 #include CORBA_CLIENT_HEADER(SALOME_ContainerManager)
25
26 #include <string>
27 #include <vector>
28 #include <map>
29
30 namespace YACS
31 {
32   namespace ENGINE
33   {
34     class Task;
35     class Container;
36     class ComponentInstance;
37     class SalomeContainerHelper;
38
39     class YACSRUNTIMESALOME_EXPORT SalomeContainerToolsBase
40     {
41     public:
42       virtual ~SalomeContainerToolsBase() { }
43       virtual std::string getProperty(const std::string& name) const = 0;
44       virtual void setProperty(const std::string& name, const std::string& value) = 0;
45       virtual const std::map<std::string,std::string>& getProperties() const = 0;
46       virtual std::map<std::string,std::string> getResourceProperties(const std::string& name) const = 0;
47       virtual void clearProperties() = 0;
48       virtual void addToComponentList(const std::string& name) = 0;
49       virtual void addToResourceList(const std::string& name) = 0;
50       virtual Engines::ContainerParameters getParameters() const = 0;
51       virtual void setContainerName(const std::string& name) = 0;
52       virtual std::string getHostName() const = 0;
53       virtual std::string getNotNullContainerName(const Container *contPtr, const Task *askingNode, bool& isEmpty) const = 0;
54       virtual std::string getContainerName() const = 0;
55       virtual int getNumberOfCoresPerWorker() const = 0;
56     public:
57       static void SetContainerNameOf(Engines::ContainerParameters& params, const std::string& name);
58     public:
59       static void Start(const std::vector<std::string>& compoNames, SalomeContainerHelper *schelp, SalomeContainerToolsBase& sct, int& shutdownLevel, const Container *cont, const Task *askingNode);
60       static CORBA::Object_ptr LoadComponent(SalomeContainerHelper *launchModeType, Container *cont, Task *askingNode);
61       static CORBA::Object_ptr CreateComponentInstance(Container *cont, Engines::Container_ptr contPtr, const ComponentInstance *inst);
62       static std::string GetPlacementId(const SalomeContainerHelper *launchModeType, const Container *cont, const Task *askingNode);
63       static std::string GetFullPlacementId(const SalomeContainerHelper *launchModeType, const Container *cont, const Task *askingNode);
64     };
65
66     class YACSRUNTIMESALOME_EXPORT SalomeContainerTools : public SalomeContainerToolsBase
67     {
68     public:
69       SalomeContainerTools();
70       SalomeContainerTools(const SalomeContainerTools& other);
71       ~SalomeContainerTools() { }
72       std::string getProperty(const std::string& name) const override;
73       void setProperty(const std::string& name, const std::string& value) override;
74       const std::map<std::string,std::string>& getProperties() const override { return _propertyMap; }
75       std::map<std::string,std::string> getResourceProperties(const std::string& name) const override;
76       void clearProperties() override;
77       void addToComponentList(const std::string& name) override;
78       void addToResourceList(const std::string& name) override;
79       Engines::ContainerParameters getParameters() const override { return _params; }
80       void setContainerName(const std::string& name) override;
81       std::string getHostName() const override;
82       std::string getNotNullContainerName(const Container *contPtr, const Task *askingNode, bool& isEmpty) const override;
83       std::string getContainerName() const override;
84       int getNumberOfCoresPerWorker() const override;
85     private:
86       std::map<std::string,std::string> _propertyMap;
87       Engines::ContainerParameters _params;
88     };
89
90     class PlayGround;
91     class SalomeHPContainerVectOfHelper;
92
93     class YACSRUNTIMESALOME_EXPORT SalomeContainerToolsDecorator : public SalomeContainerToolsBase
94     {
95     public:
96       SalomeContainerToolsDecorator(SalomeContainerToolsBase *decorated, const PlayGround *pg, SalomeHPContainerVectOfHelper *vh, const Task *node, int nbCoresPerWorker)
97       :_decorated(decorated),_pg(pg),_vh(vh),_node(node),_nb_cores_per_worker(nbCoresPerWorker) { }
98       std::string getProperty(const std::string& name) const override { return _decorated->getProperty(name); }
99       void setProperty(const std::string& name, const std::string& value) override { return _decorated->setProperty(name,value); }
100       const std::map<std::string,std::string>& getProperties() const override { return _decorated->getProperties(); }
101       std::map<std::string,std::string> getResourceProperties(const std::string& name) const override { return _decorated->getResourceProperties(name); }
102       void clearProperties() override { return _decorated->clearProperties(); }
103       void addToComponentList(const std::string& name) override { return _decorated->addToComponentList(name); }
104       void addToResourceList(const std::string& name) override { return _decorated->addToResourceList(name); }
105       // Everything for it
106       Engines::ContainerParameters getParameters() const override;
107       void setContainerName(const std::string& name) override { return _decorated->setContainerName(name); }
108       std::string getHostName() const override { return _decorated->getHostName(); }
109       std::string getNotNullContainerName(const Container *contPtr, const Task *askingNode, bool& isEmpty) const override { return _decorated->getNotNullContainerName(contPtr,askingNode,isEmpty); }
110       std::string getContainerName() const override { return _decorated->getContainerName(); }
111       int getNumberOfCoresPerWorker() const override { return _decorated->getNumberOfCoresPerWorker(); }
112     private:
113       SalomeContainerToolsBase *_decorated;
114       const PlayGround *_pg;
115       SalomeHPContainerVectOfHelper *_vh;
116       const Task *_node;
117       int _nb_cores_per_worker;
118     };
119   }
120 }