src/engine/Pool.hxx

   1 //  Copyright (C) 2006-2008  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.
   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 #ifndef __POOL_HXX__
  20 #define __POOL_HXX__
  21
  22 #include "Exception.hxx"
  23
  24 #include <list>
  25
  26 namespace YACS
  27 {
  28   namespace ENGINE
  29   {
  30     class Any;
  31     class OptimizerLoop;
  32
  33     class Pool
  34     {
  35       friend class OptimizerLoop;
  36
  37       class ExpData
  38       {
  39       private:
  40         Any *_in;
  41         Any *_out;
  42         unsigned char _priority;
  43       public:
  44         ExpData(Any *inValue, unsigned char priority);
  45         ExpData(const ExpData& other);
  46         ~ExpData();
  47         Any *inValue() const { return _in; }
  48         Any *outValue() const { return _out; }
  49         void setOutValue(Any *outValue);
  50         void markItAsInUse();
  51         bool isLaunchable() const;
  52         unsigned char getPriority() const { return _priority; }
  53       private:
  54         static Any *NOT_USED_NOR_COMPUTED;
  55         static Any *USED_BUT_NOT_COMPUTED_YET;
  56       };
  57     private:
  58       std::list< std::pair<int, ExpData> > _container;
  59       std::list< std::pair<int, ExpData> >::iterator _currentCase;
  60     public:
  61       //For algorithm use
  62       int getCurrentId() const { return (*_currentCase).first; }
  63       Any *getCurrentInSample() const { return (*_currentCase).second.inValue(); }
  64       Any *getCurrentOutSample() const { return (*_currentCase).second.outValue(); }
  65       void pushInSample(int id, Any *inSample, unsigned char priority = 0);
  66       void destroyAll();
  67     private:
  68       //For OptimizerNode use
  69       void destroyCurrentCase();
  70       void checkConsistency() throw(Exception);
  71       void setCurrentId(int id) throw(Exception);
  72       void putOutSampleAt(int id, Any *outValue) throw(Exception);
  73       Any *getNextSampleWithHighestPriority(int& id, unsigned char& priority) const;
  74       void markIdAsInUse(int id);
  75       bool empty() const;
  76     private:
  77       static const char MESSAGEFORUNXSTNGID[];
  78     };
  79   }
  80 }
  81
  82 #endif