Thea
Public Member Functions | List of all members
IPlugin Class Referenceabstract

Interface for a plugin that may be statically or dynamically loaded. More...

#include <IPlugin.hpp>

Inheritance diagram for IPlugin:
ArpackPlugin CsparsePlugin GlPlugin

Public Member Functions

virtual char const * getName () const =0
 Get the name of the plugin. More...
 
virtual void install ()=0
 Installation routine for the plugin. More...
 
virtual void shutdown ()=0
 Shutdown routine for the plugin. More...
 
virtual void startup ()=0
 Startup routine for the plugin. More...
 
virtual void uninstall ()=0
 Uninstallation routine for the plugin. More...
 
virtual ~IPlugin ()=0
 Destructor. More...
 

Detailed Description

Interface for a plugin that may be statically or dynamically loaded.

Definition at line 40 of file IPlugin.hpp.

Constructor & Destructor Documentation

~IPlugin ( )
pure virtual

Destructor.

Definition at line 85 of file IPlugin.hpp.

Member Function Documentation

virtual char const* getName ( ) const
pure virtual

Get the name of the plugin.

Implemented in GlPlugin, ArpackPlugin, and CsparsePlugin.

virtual void install ( )
pure virtual

Installation routine for the plugin.

This is called when the plugin is first registered with the plugin manager, and executes initialization tasks that depend only on core functionality and not on the availability of other plugins.

See also
uninstall()

Implemented in GlPlugin, ArpackPlugin, and CsparsePlugin.

virtual void shutdown ( )
pure virtual

Shutdown routine for the plugin.

This function assumes all dependencies are still loaded and can hence interact with other plugins. If called multiple times without an intervening startup(), the second and subsequent calls should have no effect.

See also
shutdown()

Implemented in GlPlugin, ArpackPlugin, and CsparsePlugin.

virtual void startup ( )
pure virtual

Startup routine for the plugin.

This function assumes all dependencies have been loaded and can hence interact with other plugins. If called multiple times without an intervening shutdown(), the second and subsequent calls should have no effect.

See also
startup()

Implemented in GlPlugin, ArpackPlugin, and CsparsePlugin.

virtual void uninstall ( )
pure virtual

Uninstallation routine for the plugin.

This is called when the plugin is removed from the plugin manager, and executes cleanup tasks that depend only on core functionality and not on the availability of other plugins.

See also
install()

Implemented in GlPlugin, ArpackPlugin, and CsparsePlugin.


The documentation for this class was generated from the following file: