OBT::BasicPlugin Class Reference

Basic plugin. More...

#include <OBTBasicPlugin.h>

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

List of all members.

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

Detailed Description

Basic plugin.

You can use this basic plug-in class with OBT_EXPORT_BASIC_PLUGIN_API.

Definition at line 32 of file OBTBasicPlugin.h.


Constructor & Destructor Documentation

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 destructor.

Definition at line 39 of file OBTBasicPlugin.h.

00039 {}


Member Function Documentation

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.

00058 { return true ; }

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

Get the information about the plugin.

Returns:
The _information object.

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.

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

00055 { return true ; }

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.

00047 { return 0 ; }


Friends And Related Function Documentation

friend class PluginLoaderImpl [friend]

Reimplemented from OBT::PluginInterface.

Definition at line 49 of file OBTBasicPlugin.h.


Member Data Documentation

Definition at line 60 of file OBTBasicPlugin.h.


Generated on 1 Jan 2010 for OBT by  doxygen 1.6.1