#include <OBTPluginInterface.h>
Public Member Functions | |
virtual | ~PluginInterface () |
Virtual destructor. | |
virtual const OBT::PluginInformation & | getInformation () const =0 |
Get the information about the plug-in. | |
virtual int | type () const =0 |
Returns the type of the plugin. | |
Protected Member Functions | |
PluginInterface () | |
Constructor. | |
virtual bool | init (const std::string &prm)=0 |
Initialise the plug-in. | |
virtual bool | finish ()=0 |
Ending the plug-in. | |
Friends | |
class | PluginLoaderImpl |
Plugin interface.
This simple interface is an abstract class, it declares four pure virtual methods.
See How to create a plug-in object ? to use it.
Definition at line 61 of file OBTPluginInterface.h.
OBT::PluginInterface::PluginInterface | ( | ) | [protected] |
OBT::PluginInterface::~PluginInterface | ( | ) | [virtual] |
virtual bool OBT::PluginInterface::finish | ( | ) | [protected, pure 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 ?.
Implemented in OBT::BasicPlugin, and OBT::OldPlugin.
virtual const OBT::PluginInformation& OBT::PluginInterface::getInformation | ( | ) | const [pure virtual] |
Get the information about the plug-in.
Implemented in OBT::BasicPlugin, and OBT::OldPlugin.
virtual bool OBT::PluginInterface::init | ( | const std::string & | prm | ) | [protected, pure virtual] |
Initialise the plug-in.
prm | a string to parameterise the initialisation. Can be textual parameters, xml code or a file name. |
See OBT::PluginLoaderImpl::load and How to parametrise a plug-in ?.
Implemented in OBT::BasicPlugin, and OBT::OldPlugin.
virtual int OBT::PluginInterface::type | ( | ) | const [pure virtual] |
Returns the type of the plugin.
The type is an user defined id.
The valid values are positive values, -1 is used for OldPlugin and 0 is used for BasicPlugin.
See How to get informations about the loaded plug-in ?.
Implemented in OBT::BasicPlugin, and OBT::OldPlugin.
friend class PluginLoaderImpl [friend] |
Reimplemented in OBT::BasicPlugin, and OBT::OldPlugin.
Definition at line 82 of file OBTPluginInterface.h.