OBT::OldPlugin Class Reference

Plugin interface for old plugins. More...

#include <OBTOldPlugin.h>

Inheritance diagram for OBT::OldPlugin:
[legend]
Collaboration diagram for OBT::OldPlugin:
[legend]

List of all members.

Public Member Functions

virtual const
OBT::PluginInformation
getInformation () const
 Get the information about the plugin.

Protected Member Functions

 OldPlugin (PluginLoaderImpl::GetInformationFunc getInfo, PluginLoaderImpl::InitFunc init, PluginLoaderImpl::FinishFunc finish)
 Constructor.
virtual ~OldPlugin ()
 Virtual destructor.
virtual bool init (const std::string &prm)
 Initialize the plugin.
virtual bool finish ()
 Ending the plugin.
virtual int type () const
 Returns the type of the plugin.

Private Attributes

PluginLoaderImpl::GetInformationFunc _getInfo
PluginLoaderImpl::InitFunc _init
PluginLoaderImpl::FinishFunc _finish

Friends

class PluginLoaderImpl
struct PluginImpl

Detailed Description

Plugin interface for old plugins.

The old plugins are those which are built with three entry methods.

See Can old plug-ins be loaded ? to use it.

Definition at line 15 of file OBTOldPlugin.h.


Constructor & Destructor Documentation

OBT::OldPlugin::OldPlugin ( PluginLoaderImpl::GetInformationFunc  getInfo,
PluginLoaderImpl::InitFunc  init,
PluginLoaderImpl::FinishFunc  finish 
) [inline, protected]

Constructor.

Definition at line 21 of file OBTOldPlugin.h.

00023                                                  : _getInfo( getInfo ), _init( init ), _finish( finish ) {}

virtual OBT::OldPlugin::~OldPlugin (  )  [inline, protected, virtual]

Virtual destructor.

Definition at line 25 of file OBTOldPlugin.h.

00025 {}


Member Function Documentation

virtual bool OBT::OldPlugin::finish (  )  [inline, protected, virtual]

Ending the plugin.

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 39 of file OBTOldPlugin.h.

00039 { return (*_finish)() ; }

virtual const OBT::PluginInformation& OBT::OldPlugin::getInformation (  )  const [inline, virtual]

Get the information about the plugin.

Returns:
The information.

Implements OBT::PluginInterface.

Definition at line 29 of file OBTOldPlugin.h.

00029 { return (*_getInfo)() ; }

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

Initialize the plugin.

Parameters:
prm a string to parameterize 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 36 of file OBTOldPlugin.h.

00036 { return (*_init)( prm.c_str() ) ; }

virtual int OBT::OldPlugin::type (  )  const [inline, protected, virtual]

Returns the type of the plugin.

The type is -1 for all old plugins.

See How to get informations about the loaded plug-in ?.

Implements OBT::PluginInterface.

Definition at line 44 of file OBTOldPlugin.h.

00044 { return - 1 ; }


Friends And Related Function Documentation

friend struct PluginImpl [friend]

Definition at line 18 of file OBTOldPlugin.h.

friend class PluginLoaderImpl [friend]

Reimplemented from OBT::PluginInterface.

Definition at line 17 of file OBTOldPlugin.h.


Member Data Documentation

Definition at line 48 of file OBTOldPlugin.h.

Definition at line 46 of file OBTOldPlugin.h.

Definition at line 47 of file OBTOldPlugin.h.


Generated on 1 Jan 2010 for OBT by  doxygen 1.6.1