src/engine/HomogeneousPoolContainer.hxx

   1 // Copyright (C) 2006-2020  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 #pragma once
  21
  22 #include "YACSlibEngineExport.hxx"
  23 #include "Exception.hxx"
  24 #include "Container.hxx"
  25 #include "PlayGround.hxx"
  26
  27 #include <vector>
  28
  29 namespace YACS
  30 {
  31   namespace ENGINE
  32   {
  33     class ForTestOmlyHPContCls;
  34
  35     /*!
  36      * This is an abstract class, that represents a set of fixed number of worker "kernelcontainers" homegenous in the sense that can be used indifferently each other.
  37      * But each of those worker pool can be used once at a time.
  38      */
  39     class YACSLIBENGINE_EXPORT HomogeneousPoolContainer : public Container
  40     {
  41     public:
  42       void attachOnCloning() const;
  43       void dettachOnCloning() const;
  44       bool isAttachedOnCloning() const;
  45       void setAttachOnCloningStatus(bool val) const;
  46       virtual void assignPG(const PlayGround *pg);
  47       std::mutex &getLocker() const { return this->getPG()->getLocker(); }
  48       //
  49       virtual void setSizeOfPool(int sz) = 0;
  50       virtual int getSizeOfPool() const = 0;
  51       virtual std::size_t getNumberOfFreePlace() const = 0;
  52       virtual void allocateFor(const std::vector<const Task *>& nodes) = 0;
  53       virtual void release(const Task *node) = 0;
  54       virtual int getNumberOfCoresPerWorker() const = 0;
  55       static const char SIZE_OF_POOL_KEY[];
  56       static const char INITIALIZE_SCRIPT_KEY[];
  57     protected:
  58       HomogeneousPoolContainer();
  59 #ifndef SWIG
  60       virtual ~HomogeneousPoolContainer();
  61 #endif
  62     protected:
  63       const PlayGround *getPG() const;
  64     private:
  65       YACS::BASES::AutoConstRefCnt<PlayGround> _pg;
  66     };
  67   }
  68 }
  69