OBTPlugin.h

Go to the documentation of this file.

#ifndef OBTPlugin_H
#define OBTPlugin_H

#ifdef _MSC_VER
#include <windows.h>
#endif

#include <string>

#include "OBT.h"

namespace OBT
{

class PluginInformation ;

class OBT_API Plugin
{
public:

  typedef bool ( *InitFunc )(  const char* configurationFile ) ;

  typedef bool ( *DeInitFunc )() ;

  typedef const PluginInformation& ( *PluginInformationFunc )() ;

  Plugin( const char* path, const char* name, const char* configurationFile = 0 ) ;

  virtual ~Plugin() ;

  bool load() ;

  bool unload() ;

  bool isLoaded() const ;

  const PluginInformation& getInformation() const ;

  const char* getPath() const ;

  const char* getConfigurationFile() const ;

private:

  Plugin( const Plugin& ) ;
  Plugin& operator = ( const Plugin& ) ;
#ifdef _MSC_VER
  HINSTANCE _pluginHandle ;
#else
  void* _pluginHandle ;
#endif

bool _initialised ;

  std::string _path ;

  std::string _configurationFile ;
} ;

//-------------------------------------------------------------------------
// IsLoaded()
//-------------------------------------------------------------------------
inline bool
        Plugin::isLoaded() const
{
        return _initialised ;
}

//-------------------------------------------------------------------------
// GetPath
//-------------------------------------------------------------------------
inline const char*
  Plugin::getPath() const
{
  return _path.c_str() ;
}

//-------------------------------------------------------------------------
// GetConfigurationFile
//-------------------------------------------------------------------------
inline const char*
  Plugin::getConfigurationFile() const
{
  return _configurationFile.empty() ? NULL : _configurationFile.c_str() ;
}
}

#endif //OBTPlugin_H

---