module_manager.h

Go to the documentation of this file.

/*
 *  module_manager.h
 *
 *  This file is part of NEST.
 *
 *  Copyright (C) 2004 The NEST Initiative
 *
 *  NEST 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 2 of the License, or
 *  (at your option) any later version.
 *
 *  NEST 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 NEST.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
 
#ifndef MODULE_MANAGER_H
#define MODULE_MANAGER_H
 
// Generated includes:
#include "config.h"
 
// C++ includes:
#include <map>
#include <string>
 
// Includes from nestkernel:
#include "manager_interface.h"
 
// DynamicLoaderModule defined only if libltdl is available
#ifdef HAVE_LIBLTDL
#include <ltdl.h>
 
namespace nest
{
class NESTExtensionInterface;
 
class ModuleManager : public ManagerInterface
{
public:
  ModuleManager();
  ~ModuleManager() override;
 
  void initialize( const bool ) override;
 
  void finalize( const bool adjust_number_of_threads_or_rng_only ) override;
 
  void reinitialize_dynamic_modules();
 
  void get_status( Dictionary& ) override;
  void set_status( const Dictionary& ) override;
 
  void install( const std::string& name );
 
private:
  struct ModuleMapEntry_
  {
    ModuleMapEntry_() = default;
    ModuleMapEntry_( lt_dlhandle hndl, NESTExtensionInterface* ext )
      : handle( hndl )
      , extension( ext )
    {
    }
 
    lt_dlhandle handle;                 
    NESTExtensionInterface* extension;  
  };
 
  std::map< std::string, ModuleMapEntry_ > modules_;
};
}
 
#else
 
#include "exceptions.h"
 
namespace nest
{
class ModuleManager : public ManagerInterface
{
public:
  ModuleManager()
  {
  }
  ~ModuleManager() override
  {
  }
 
  void
  initialize( const bool ) override
  {
  }
  void
  finalize( const bool ) override
  {
  }
 
  void
  reinitialize_dynamic_modules()
  {
  }
 
  void
  get_status( Dictionary& ) override
  {
  }
  void
  set_status( const Dictionary& ) override
  {
  }
 
  void
  install( const std::string& )
  {
    throw KernelException( "Dynamic modules not supported without libltdl." );
  }
};
}
 
#endif  // HAVE_LIBLTDL
 
#endif  // #ifndef MODULE_MANAGER_H