The base class for all plug-ins.
More...
#include <mia/core/plugin_base.hh>
The base class for all plug-ins.
The base class for all plug-ins. It supports handling parameters and a provides a help interface.
Definition at line 64 of file plugin_base.hh.
◆ CPluginBase()
CPluginBase::CPluginBase |
( |
const char * |
name | ) |
|
The constructor initialises the plug-in with its name and sets its link-up to nil ant initialises its parameter map.
- Parameters
-
◆ ~CPluginBase()
virtual CPluginBase::~CPluginBase |
( |
| ) |
|
|
virtual |
this destructur exists for the sole purpouse to ensure a virtual destructor for all plug-ins.
◆ add_dependend_handlers()
void CPluginBase::add_dependend_handlers |
( |
HandlerHelpMap & |
handler_map | ) |
|
Add all plugin handlers that may be called by this plugin
- Parameters
-
◆ add_property()
void CPluginBase::add_property |
( |
const char * |
property | ) |
|
Add a porperty to the map of supported properties
- Parameters
-
◆ append_interface()
void CPluginBase::append_interface |
( |
CPluginBase * |
plugin | ) |
|
link up another plug-in in order to be able to put several plug-ins of the same type into the same dynamic library
◆ get_module()
◆ get_priority()
unsigned CPluginBase::get_priority |
( |
| ) |
const |
- Returns
- the priority of the plug-in
◆ has_property()
bool CPluginBase::has_property |
( |
const char * |
property | ) |
const |
- Parameters
-
- Returns
- true if the property is supported, false otherwise
◆ next_interface()
- Returns
- a pointer to the next plug-in, or NULL, if it doesn't exist
◆ set_module()
set the shared modules containing the code of this plugin This enshures that the modules is not unloaded while the plug-in still exists and needs to call its destructor whos code resides in the module.
- Parameters
-
◆ set_priority()
void CPluginBase::set_priority |
( |
unsigned |
p | ) |
|
Set the plug-in priority, if two plug-ins of the same type and name are loaded, then the one with the higher priority is kept.
- Parameters
-
The documentation for this class was generated from the following file: