Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Plugin.h
Go to the documentation of this file.
1 /*
2 
3 License
4 
5 Menge
6 Copyright and trademark 2012-14 University of North Carolina at Chapel Hill.
7 All rights reserved.
8 
9 Permission to use, copy, modify, and distribute this software and its documentation
10 for educational, research, and non-profit purposes, without fee, and without a
11 written agreement is hereby granted, provided that the above copyright notice,
12 this paragraph, and the following four paragraphs appear in all copies.
13 
14 This software program and documentation are copyrighted by the University of North
15 Carolina at Chapel Hill. The software program and documentation are supplied "as is,"
16 without any accompanying services from the University of North Carolina at Chapel
17 Hill or the authors. The University of North Carolina at Chapel Hill and the
18 authors do not warrant that the operation of the program will be uninterrupted
19 or error-free. The end-user understands that the program was developed for research
20 purposes and is advised not to rely exclusively on the program for any reason.
21 
22 IN NO EVENT SHALL THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL OR THE AUTHORS
23 BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL
24 DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS
25 DOCUMENTATION, EVEN IF THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL OR THE
26 AUTHORS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 
28 THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL AND THE AUTHORS SPECIFICALLY
29 DISCLAIM ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
30 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE AND ANY STATUTORY WARRANTY
31 OF NON-INFRINGEMENT. THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND
32 THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL AND THE AUTHORS HAVE NO OBLIGATIONS
33 TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
34 
35 Any questions or comments should be sent to the authors {menge,geom}@cs.unc.edu
36 
37 */
38 
44 #ifndef __PLUGIN_H__
45 #define __PLUGIN_H__
46 
47 #include <string>
48 #include "SharedLibrary.h"
49 
50 namespace Menge {
51 
52  class PluginEngine;
53 
57  class Plugin {
58  public:
62  typedef const char * GetCharPtrFcn();
63 
67  typedef void RegisterPluginFcn( PluginEngine * );
68 
75  MENGE_API Plugin( const std::string & filename );
76 
80  MENGE_API ~Plugin();
81 
87  MENGE_API void registerPlugin( PluginEngine * engine ) {
88  _registerFcnAddr( engine );
89  }
90 
96  MENGE_API const char * getName() {
97  return _getNameFcnAddr();
98  }
99 
105  MENGE_API const char * getDescription() {
106  return _getDescFcnAddr();
107  }
108 
109  private:
113  SharedLibrary::HandleType _handle;
114 
120  RegisterPluginFcn * _registerFcnAddr;
121 
125  GetCharPtrFcn * _getNameFcnAddr;
126 
130  GetCharPtrFcn * _getDescFcnAddr;
131  };
132 
133 } // namespace Menge
134 
135 #endif // __PLUGIN_H__
const char * GetCharPtrFcn()
Plugin function pointer for functions which return strings.
Definition: Plugin.h:62
The core namespace. All elements of Menge are contained in this namespace.
Definition: AgentGenerator.cpp:43
MENGE_API Plugin(const std::string &filename)
Constructor.
Definition: Plugin.cpp:49
MENGE_API ~Plugin()
Destructor.
Definition: Plugin.cpp:71
Functions for loading and unloading shared libraries.
MENGE_API const char * getName()
Returns the name of the plugin.
Definition: Plugin.h:96
The class responsible for finding, managing, and deleting plugins.
Definition: PluginEngine.h:91
MENGE_API const char * getDescription()
Returns the description of the plugin.
Definition: Plugin.h:105
void RegisterPluginFcn(PluginEngine *)
Declaration of registration function pointer type.
Definition: Plugin.h:67
MENGE_API void registerPlugin(PluginEngine *engine)
Registers the plugin to the PluginEngine.
Definition: Plugin.h:87
The base plug-in class.
Definition: Plugin.h:57