src/engine/Pool.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 __POOL_HXX__
  21 #define __POOL_HXX__
  22
  23 #include "YACSlibEngineExport.hxx"
  24 #include "Exception.hxx"
  25
  26 #include <list>
  27
  28 namespace YACS
  29 {
  30   namespace ENGINE
  31   {
  32     class Any;
  33     class OptimizerLoop;
  34
  35     /*! \brief Pool used to manage the samples of the optimizer loop plugin.
  36      *
  37      *  Every sample has an identifier (Id), a priority, an initial value (In)
  38      *  and an evaluation value (Out).
  39      *  The current sample is the sample used by the latest terminated evaluation.
  40      */
  41     class YACSLIBENGINE_EXPORT Pool
  42     {
  43       friend class OptimizerLoop;
  44
  45       class ExpData
  46       {
  47       private:
  48         Any *_in;
  49         Any *_out;
  50         unsigned char _priority;
  51       public:
  52         ExpData(Any *inValue, unsigned char priority);
  53         ExpData(const ExpData& other);
  54         ~ExpData();
  55         Any *inValue() const { return _in; }
  56         Any *outValue() const { return _out; }
  57         void setOutValue(Any *outValue);
  58         void markItAsInUse();
  59         bool isLaunchable() const;
  60         unsigned char getPriority() const { return _priority; }
  61       private:
  62         static Any *NOT_USED_NOR_COMPUTED;
  63         static Any *USED_BUT_NOT_COMPUTED_YET;
  64       };
  65     private:
  66       std::list< std::pair<int, ExpData> > _container;
  67       std::list< std::pair<int, ExpData> >::iterator _currentCase;
  68     public:
  69       //For algorithm use
  70       int getCurrentId() const ;
  71       Any *getCurrentInSample() const ;
  72       Any *getCurrentOutSample() const ;
  73       Any *getOutSample(int id);
  74       void pushInSample(int id, Any *inSample, unsigned char priority = 0);
  75       void destroyAll();
  76     private:
  77       //For OptimizerNode use
  78       void destroyCurrentCase();
  79       void checkConsistency() throw(Exception);
  80       void setCurrentId(int id) throw(Exception);
  81       void putOutSampleAt(int id, Any *outValue) throw(Exception);
  82       Any *getNextSampleWithHighestPriority(int& id, unsigned char& priority) const;
  83       void markIdAsInUse(int id);
  84       bool empty() const;
  85     private:
  86       static const char MESSAGEFORUNXSTNGID[];
  87     };
  88   }
  89 }
  90
  91 #endif