Basic plugin. More...
#include <OBTBasicPlugin.h>
Public Member Functions | |
virtual | ~BasicPlugin () |
Virtual destructor. | |
virtual const OBT::PluginInformation & | getInformation () const |
Get the information about the plugin. | |
virtual int | type () const |
Returns the type of the plugin. | |
Protected Member Functions | |
BasicPlugin (const OBT::PluginInformation &info) | |
Constructor. | |
virtual bool | init (const std::string &prm) |
Initialize the plug-in. | |
virtual bool | finish () |
Ending the plug-in. | |
Protected Attributes | |
OBT::PluginInformation | _information |
Friends | |
class | PluginLoaderImpl |
Basic plugin.
You can use this basic plug-in class with OBT_EXPORT_BASIC_PLUGIN_API.
Definition at line 32 of file OBTBasicPlugin.h.
OBT::BasicPlugin::BasicPlugin | ( | const OBT::PluginInformation & | info | ) | [inline, protected] |
Constructor.
Definition at line 36 of file OBTBasicPlugin.h.
00036 : PluginInterface(), _information( info ) {}
virtual OBT::BasicPlugin::~BasicPlugin | ( | ) | [inline, virtual] |
virtual bool OBT::BasicPlugin::finish | ( | ) | [inline, protected, virtual] |
Ending the plug-in.
See OBT::PluginLoaderImpl::unload, How to unload a plug-in object ? and What are the error messages during a load ?.
Implements OBT::PluginInterface.
Definition at line 58 of file OBTBasicPlugin.h.
virtual const OBT::PluginInformation& OBT::BasicPlugin::getInformation | ( | ) | const [inline, virtual] |
Get the information about the plugin.
Implements OBT::PluginInterface.
Definition at line 42 of file OBTBasicPlugin.h.
00042 { return _information ; }
virtual bool OBT::BasicPlugin::init | ( | const std::string & | prm | ) | [inline, protected, virtual] |
Initialize the plug-in.
prm | a string to parameterise the initialization. Can be textual parameters, xml code or a file name. |
See OBT::PluginLoaderImpl::load and How to parametrise a plug-in ?.
Implements OBT::PluginInterface.
Definition at line 55 of file OBTBasicPlugin.h.
virtual int OBT::BasicPlugin::type | ( | ) | const [inline, virtual] |
Returns the type of the plugin.
The type is 0.
See How to get informations about the loaded plug-in ?.
Implements OBT::PluginInterface.
Definition at line 47 of file OBTBasicPlugin.h.
friend class PluginLoaderImpl [friend] |
Reimplemented from OBT::PluginInterface.
Definition at line 49 of file OBTBasicPlugin.h.
OBT::PluginInformation OBT::BasicPlugin::_information [protected] |
Definition at line 60 of file OBTBasicPlugin.h.