src/engine/Container.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 __CONTAINER_HXX__
  21 #define __CONTAINER_HXX__
  22
  23 #include "YACSlibEngineExport.hxx"
  24 #include "Exception.hxx"
  25 #include "RefCounter.hxx"
  26
  27 #include <list>
  28 #include <map>
  29
  30 namespace YACS
  31 {
  32   namespace ENGINE
  33   {
  34     class ComponentInstance;
  35     class Proc;
  36     class Task;
  37     /*!
  38      * This is an abstract class, that represents an abstract process in which ComponentInstances can be launched and run.
  39      * An instance of this will be mapped to one and only one physical container (except in the foreach context)
  40      */
  41     class YACSLIBENGINE_EXPORT Container : public RefCounter
  42     {
  43     protected:
  44       Container();
  45 #ifndef SWIG
  46       virtual ~Container();
  47 #endif
  48     public:
  49       virtual std::string getKind() const = 0;
  50       //Execution only methods
  51       virtual std::string getDiscreminantStrOfThis(const Task *askingNode) const;
  52       virtual bool isAlreadyStarted(const Task *askingNode) const = 0;
  53       virtual void start(const Task *askingNode) throw(Exception) = 0;
  54       virtual std::string getPlacementId(const Task *askingNode) const = 0;
  55       virtual std::string getFullPlacementId(const Task *askingNode) const = 0;
  56       //Edition only methods
  57       virtual void setAttachOnCloningStatus(bool val) const;
  58       virtual void attachOnCloning() const;
  59       virtual void dettachOnCloning() const;
  60       virtual bool isAttachedOnCloning() const;
  61       virtual void lock() = 0;
  62       virtual void unLock() = 0;
  63       //! \b WARNING ! clone behaviour \b MUST be in coherence with what is returned by isAttachedOnCloning() method
  64       virtual Container *clone() const = 0;
  65       virtual Container *cloneAlways() const = 0;
  66       virtual bool isSupportingRTODefNbOfComp() const;
  67       virtual void checkCapabilityToDealWith(const ComponentInstance *inst) const throw(Exception) = 0;
  68       virtual void setProperty(const std::string& name,const std::string& value) = 0;
  69       virtual std::string getProperty(const std::string& name) const = 0;
  70       virtual void clearProperties() = 0;
  71       virtual void addComponentName(const std::string& name) = 0;
  72       virtual std::map<std::string,std::string> getProperties() const = 0;
  73       virtual std::map<std::string,std::string> getResourceProperties(const std::string& name) const = 0;
  74       virtual void setProperties(const std::map<std::string,std::string>& properties);
  75       std::string getName() const { return _name; }
  76       //! \b WARNING ! name is used in edition to identify different containers, it is not the runtime name of the container
  77       void setName(std::string name) { _name = name; }
  78       void setProc(Proc* proc) { _proc = proc; }
  79       Proc* getProc() { return _proc; }
  80       virtual void shutdown(int level) = 0;
  81       static const char KIND_ENTRY[];
  82       static const char AOC_ENTRY[];
  83     protected:
  84       std::string _name;
  85       mutable bool _isAttachedOnCloning;
  86       Proc* _proc;
  87     };
  88   }
  89 }
  90
  91 #endif