src/runtime/PyOptimizerAlg.hxx

   1 // Copyright (C) 2006-2022  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 #ifndef __PYOPTIMIZERALG_HXX__
  20 #define __PYOPTIMIZERALG_HXX__
  21
  22 #include "YACSRuntimeSALOMEExport.hxx"
  23 #include "OptimizerAlg.hxx"
  24
  25 namespace YACS
  26 {
  27   namespace ENGINE
  28   {
  29     /*!
  30      *  \brief Base class factorizing common methods for python algorithms interfaces.
  31      */
  32     class YACSRUNTIMESALOME_EXPORT PyOptimizerAlgBase : public OptimizerAlgBase
  33     {
  34     public:
  35       virtual ~PyOptimizerAlgBase();
  36
  37       virtual TypeCode *getTCForInProxy() const;
  38       virtual TypeCode *getTCForOutProxy() const;
  39       virtual TypeCode *getTCForAlgoInitProxy() const;
  40       virtual TypeCode *getTCForAlgoResultProxy() const;
  41       virtual void initializeProxy(const Any *input) ;
  42       virtual void startProxy();
  43       virtual void takeDecisionProxy();
  44       virtual void finishProxy();
  45       virtual Any * getAlgoResultProxy();
  46
  47     protected:
  48       PyOptimizerAlgBase(Pool *pool);
  49     };
  50
  51     typedef PyOptimizerAlgBase PyOptimizerAlgSync;
  52
  53     /*!
  54      *  \brief Base class to implement in external dynamic lib or external python module
  55      *  in case of a non event oriented optimizer using Python code.
  56      */
  57     class YACSRUNTIMESALOME_EXPORT PyOptimizerAlgASync : public PyOptimizerAlgBase,
  58                                                          public YACS::BASES::AlternateThread
  59     {
  60     public:
  61       virtual ~PyOptimizerAlgASync();
  62
  63       virtual void startProxy();
  64       virtual void takeDecisionProxy();
  65       virtual void finishProxy();//! Called when optimization has succeed.
  66       virtual void signalMasterAndWait();
  67
  68     protected:
  69       PyOptimizerAlgASync(Pool *pool);
  70
  71       virtual void start();//! Update _pool attribute before performing anything.
  72       virtual void takeDecision();//! _pool->getCurrentId gives the \b id at the origin of this call.
  73                                   //! Perform the job of analysing to know what new jobs to do (_pool->pushInSample)
  74                                   //! or in case of convergence _pool->destroyAll
  75
  76       virtual void run();
  77       //! _pool->getCurrentId gives the \b id at the origin of this call.
  78       //! Perform the job between 2 'condition->wait()' of analysing to know what new jobs to do
  79       //! (_pool->pushInSample) or in case of convergence _pool->destroyAll
  80       //! WARNING ! 'condition->wait()' must be called before any analyse of Pool.
  81       virtual void startToTakeDecision()=0;
  82     };
  83   }
  84 }
  85
  86 #endif