dynamicloader.h

Go to the documentation of this file.

/*
 *  dynamicloader.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 DYNAMICLOADER_H
#define DYNAMICLOADER_H

#include "config.h"

// DynamicLoaderModule defined only if libltdl is available

#ifdef HAVE_LIBLTDL

#include "slimodule.h"
#include "slifunction.h"

#include <vector>

class DynModule;

namespace nest
{

  // structure to store handles and pointers to modules
  struct sDynModule;

  typedef std::vector<sDynModule> vecDynModules;

  typedef std::vector<DynModule*> vecLinkedModules;
   
  class Network;

   
  class DynamicLoaderModule: public SLIModule
    {
    public:
     
      DynamicLoaderModule(Network *pNet, SLIInterpreter &interpreter);
      ~DynamicLoaderModule();

      void init(SLIInterpreter *);

      const std::string commandstring(void) const;
      const std::string name(void) const;


      static int registerLinkedModule(DynModule *pModule);

      void initLinkedModules(SLIInterpreter &);
     
    public:
     
      class LoadModuleFunction : public SLIFunction
    {
    public:
    LoadModuleFunction(Network *pNet, vecDynModules &dyn_modules);

    private:
      void execute(SLIInterpreter *) const;

    private:
      Network *pNet_;
      vecDynModules &dyn_modules_;
    };

      class UnloadModuleFunction : public SLIFunction
    {
    public:
      UnloadModuleFunction(Network *pNet, vecDynModules &dyn_modules);

    private:
      void execute(SLIInterpreter *) const;

    private:
      Network *pNet_;
      vecDynModules &dyn_modules_;
      
    };



      LoadModuleFunction          loadmodule_function;
      UnloadModuleFunction        unloadmodule_function;
      
    private:
       static vecLinkedModules& getLinkedModules();
     
      // vector to store handles and pointers to dynamic modules
      vecDynModules dyn_modules;

      Network *pNet_;
      static Dictionary* moduledict_;        
    };

} // namespace

#endif  // HAVE_LIBLTDL

#endif