SimulatorPluginsManager.hpp

Go to the documentation of this file.

/*
 
  This file is part of OpenFLUID software
  Copyright(c) 2021-2026, INRAE
 
 
 == GNU General Public License Usage ==
 
  OpenFLUID is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.
 
  OpenFLUID 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 General Public License for more details.
 
  You should have received a copy of the GNU General Public License
  along with OpenFLUID. If not, see <http://www.gnu.org/licenses/>.
 
 
 == Other Usage ==
 
  Other Usage means a use of OpenFLUID that is inconsistent with the GPL
  license, and requires a written agreement between You and INRA.
  Licensees for Other Usage of OpenFLUID may use this file in accordance
  with the terms contained in the written agreement between You and INRA.
  
*/
 
 
/**
  @file SimulatorPluginsManager.hpp
 
  @author Jean-Christophe FABRE <jean-christophe.fabre@inra.fr>
 */
 
 
#ifndef __OPENFLUID_MACHINE_SIMULATORPLUGINSMANAGER_HPP__
#define __OPENFLUID_MACHINE_SIMULATORPLUGINSMANAGER_HPP__
 
 
#include <string>
 
#include <openfluid/ware/PluggableSimulator.hpp>
#include <openfluid/ware/SimulatorSignature.hpp>
#include <openfluid/machine/WarePluginsManager.hpp>
#include <openfluid/base/Environment.hpp>
#include <openfluid/fluidx/GeneratorDescriptor.hpp>
#include <openfluid/base/SingletonMacros.hpp>
 
 
namespace openfluid { namespace machine {
 
 
class OPENFLUID_API SimulatorPluginsManager : 
  public WarePluginsManager<openfluid::ware::SimulatorSignature,openfluid::ware::PluggableSimulator,
                            openfluid::ware::GetPluggableSimulatorSignatureProc,
                            openfluid::ware::GetPluggableSimulatorBodyProc>
{
 
  OPENFLUID_SINGLETON_DEFINITION(SimulatorPluginsManager)
 
 
  private:
 
    SimulatorPluginsManager() : WarePluginsManager<openfluid::ware::SimulatorSignature,
                                                   openfluid::ware::PluggableSimulator,
                                                   openfluid::ware::GetPluggableSimulatorSignatureProc,
                                                   openfluid::ware::GetPluggableSimulatorBodyProc>()
    { }
 
 
    ~SimulatorPluginsManager()
    {  }
 
 
    // =====================================================================
    // =====================================================================
 
 
    WareContainer<openfluid::ware::SimulatorSignature> createContainer() const
    {
      return WareContainer<openfluid::ware::SimulatorSignature>(openfluid::ware::WareType::SIMULATOR);
    }
 
 
    // =====================================================================
    // =====================================================================
 
 
  public:
 
    std::string getPluginFullPath(const std::string& Filename) const
    {
      return openfluid::base::Environment::getSimulatorFullPath(Filename);
    }
 
 
    // =====================================================================
    // =====================================================================
 
 
    std::vector<std::string> getPluginsSearchPaths() const
    {
      return openfluid::base::Environment::getSimulatorsDirs();
    }
 
 
    // =====================================================================
    // =====================================================================
 
 
    std::string getPluginFilenameSuffix() const
    {
      return openfluid::config::SIMULATORS_PLUGINS_SUFFIX;
    }
 
 
    // =====================================================================
    // =====================================================================
 
 
    /**
      Searches for available ghosts using the standard and user paths
      @param[in] IDPattern if not empty, the list of available wares is filtered using the given pattern 
                           based on wildcard matching
      @return the found ghosts
    */ 
    std::vector<WareContainer<openfluid::ware::SimulatorSignature>> 
    getAvailableGhosts(const std::string& IDPattern = "") const;
 
};
 
 
} }  // namespaces
 
#endif /* __OPENFLUID_MACHINE_SIMULATORPLUGINSMANAGER_HPP__ */