Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | List of all members
Menge::Plugin Class Reference

The base plug-in class. More...

#include <Plugin.h>

Public Types

typedef const char * GetCharPtrFcn ()
 Plugin function pointer for functions which return strings.
 
typedef void RegisterPluginFcn (PluginEngine *)
 Declaration of registration function pointer type.
 

Public Member Functions

MENGE_API Plugin (const std::string &filename)
 Constructor. More...
 
MENGE_API ~Plugin ()
 Destructor.
 
MENGE_API void registerPlugin (PluginEngine *engine)
 Registers the plugin to the PluginEngine. More...
 
MENGE_API const char * getName ()
 Returns the name of the plugin. More...
 
MENGE_API const char * getDescription ()
 Returns the description of the plugin. More...
 

Detailed Description

The base plug-in class.

Constructor & Destructor Documentation

Menge::Plugin::Plugin ( const std::string &  filename)

Constructor.

Parameters
filenameThe filename of the plugin to instantiate.
Exceptions
std::exceptionif there is a problem initializing the plugin.

Member Function Documentation

MENGE_API const char* Menge::Plugin::getDescription ( )
inline

Returns the description of the plugin.

Returns
The description of the plug-in.
MENGE_API const char* Menge::Plugin::getName ( )
inline

Returns the name of the plugin.

Returns
The name of the plug-in.
MENGE_API void Menge::Plugin::registerPlugin ( PluginEngine engine)
inline

Registers the plugin to the PluginEngine.

Parameters
engineThe PluginEngine

The documentation for this class was generated from the following files: