SalomeContainer.hxx

Go to the documentation of this file.

// Copyright (C) 2006-2016  CEA/DEN, EDF R&D
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//

#ifndef __SALOMECONTAINER_HXX__
#define __SALOMECONTAINER_HXX__

#include "YACSRuntimeSALOMEExport.hxx"
#include "Container.hxx"
#include "SalomeContainerTools.hxx"
#include "SalomeContainerHelper.hxx"
#include "Mutex.hxx"
#include <string>
#include <vector>
#include CORBA_CLIENT_HEADER(SALOME_Component)

namespace YACS
{
  namespace ENGINE
  {
    class SalomeComponent;

    class YACSRUNTIMESALOME_EXPORT SalomeContainer : public Container
    {
      friend class SalomeComponent;
    public:
      SalomeContainer();
      SalomeContainer(const SalomeContainer& other);
#ifndef SWIG
      SalomeContainer(const Container& other, const SalomeContainerTools& sct, const SalomeContainerHelper *lmt, const std::vector<std::string>& componentNames, int shutdownLev);
#endif

      void lock();
      void unLock();
      std::string getKind() const;
      bool isAlreadyStarted(const Task *askingNode) const;
      Engines::Container_ptr getContainerPtr(const Task *askingNode) const;
      void start(const Task *askingNode) throw (Exception);
      Container *clone() const;
      Container *cloneAlways() const;
      std::string getPlacementId(const Task *askingNode) const;
      std::string getFullPlacementId(const Task *askingNode) const;
      void checkCapabilityToDealWith(const ComponentInstance *inst) const throw (Exception);
      void setProperty(const std::string& name, const std::string& value);
      std::string getProperty(const std::string& name) const;
      void clearProperties();
      void addComponentName(const std::string& name);
      void addToResourceList(const std::string& name);
      virtual CORBA::Object_ptr loadComponent(Task *inst);
      void shutdown(int level);
      // Helper methods
      std::map<std::string,std::string> getResourceProperties(const std::string& name) const;
      std::map<std::string,std::string> getProperties() const;
      static const char KIND[];
      static const char TYPE_PROPERTY_STR[];
    protected:
#ifndef SWIG
      virtual ~SalomeContainer();
#endif
    protected:
      YACS::BASES::Mutex _mutex;
      std::vector<std::string> _componentNames;
      SalomeContainerHelper *_launchModeType;
      int _shutdownLevel;
      SalomeContainerTools _sct;
    };
  }
}

#endif