ug4
plugin_util.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2011-2015: G-CSC, Goethe University Frankfurt
3  * Author: Sebastian Reiter
4  *
5  * This file is part of UG4.
6  *
7  * UG4 is free software: you can redistribute it and/or modify it under the
8  * terms of the GNU Lesser General Public License version 3 (as published by the
9  * Free Software Foundation) with the following additional attribution
10  * requirements (according to LGPL/GPL v3 §7):
11  *
12  * (1) The following notice must be displayed in the Appropriate Legal Notices
13  * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
14  *
15  * (2) The following notice must be displayed at a prominent place in the
16  * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
17  *
18  * (3) The following bibliography is recommended for citation and must be
19  * preserved in all covered files:
20  * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
21  * parallel geometric multigrid solver on hierarchically distributed grids.
22  * Computing and visualization in science 16, 4 (2013), 151-164"
23  * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
24  * flexible software system for simulating pde based models on high performance
25  * computers. Computing and visualization in science 16, 4 (2013), 165-179"
26  *
27  * This program is distributed in the hope that it will be useful,
28  * but WITHOUT ANY WARRANTY; without even the implied warranty of
29  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
30  * GNU Lesser General Public License for more details.
31  */
32 
33 #ifndef __H__UG__plugin_util__
34 #define __H__UG__plugin_util__
35 
36 #include <string>
37 #include <vector>
38 #include "common/ug_config.h"
39 #include "registry/registry.h"
40 
41 namespace ug
42 {
43 
46 
48 UG_API bool LoadPlugins(const char* pluginPath, std::string parentGroup,
49  bridge::Registry& reg, bool bPrefixGroup=false);
50 UG_API bool UnloadPlugins();
51 UG_API bool PluginLoaded(const std::string &name);
52 UG_API std::vector<std::string> GetLoadedPlugins();
53 
54 // end group ugbase_common_util
56 
57 }// end of namespace
58 
59 #endif
location name
Definition: checkpoint_util.lua:128
Registry for functions and classes that are exported to scripts and visualizations.
Definition: registry.h:138
UG_API std::vector< std::string > GetLoadedPlugins()
Definition: plugin_util_dynamic.cpp:203
UG_API bool PluginLoaded(const std::string &name)
UG_API bool LoadPlugins(const char *pluginPath, std::string parentGroup, bridge::Registry &reg, bool bPrefixGroup=false)
Loads all plugins in the given path.
UG_API bool UnloadPlugins()
Definition: plugin_util_dynamic.cpp:184
#define UG_API
Definition: ug_config.h:65
the ug namespace