src/engine/HomogeneousPoolContainer.hxx

   1 // Copyright (C) 2006-2014  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 __HOMOGENEOUSPOOLCONTAINER_HXX__
  21 #define __HOMOGENEOUSPOOLCONTAINER_HXX__
  22
  23 #include "YACSlibEngineExport.hxx"
  24 #include "Exception.hxx"
  25 #include "Container.hxx"
  26
  27 #include <vector>
  28
  29 namespace YACS
  30 {
  31   namespace ENGINE
  32   {
  33     /*!
  34      * 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.
  35      * But each of those worker pool can be used once at a time.
  36      */
  37     class YACSLIBENGINE_EXPORT HomogeneousPoolContainer : public Container
  38     {
  39     public:
  40       virtual void setSizeOfPool(int sz) = 0;
  41       virtual std::size_t getNumberOfFreePlace() const = 0;
  42       virtual void allocateFor(const std::vector<const Task *>& nodes) = 0;
  43       virtual void release(const Task *node) = 0;
  44     protected:
  45       HomogeneousPoolContainer();
  46 #ifndef SWIG
  47       virtual ~HomogeneousPoolContainer();
  48 #endif
  49     };
  50   }
  51 }
  52
  53 #endif