OBT::PluginInterface Class Reference

Plugin interface. More...

#include <OBTPluginInterface.h>

Inheritance diagram for OBT::PluginInterface:
[legend]

List of all members.

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

Detailed Description

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.


Constructor & Destructor Documentation

OBT::PluginInterface::PluginInterface (  )  [protected]

Constructor.

Definition at line 3 of file OBTPluginInterface.cpp.

00004 {
00005 }

OBT::PluginInterface::~PluginInterface (  )  [virtual]

Virtual destructor.

Definition at line 7 of file OBTPluginInterface.cpp.

00008 {
00009 }


Member Function Documentation

virtual bool OBT::PluginInterface::finish (  )  [protected, pure virtual]
virtual const OBT::PluginInformation& OBT::PluginInterface::getInformation (  )  const [pure virtual]

Get the information about the plug-in.

Returns:
The information.

Implemented in OBT::BasicPlugin, and OBT::OldPlugin.

virtual bool OBT::PluginInterface::init ( const std::string &  prm  )  [protected, pure virtual]

Initialise the plug-in.

Parameters:
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.


Friends And Related Function Documentation

friend class PluginLoaderImpl [friend]

Reimplemented in OBT::BasicPlugin, and OBT::OldPlugin.

Definition at line 82 of file OBTPluginInterface.h.


Generated on 1 Jan 2010 for OBT by  doxygen 1.6.1