eLynx SDK v3.3.0
C++ image processing API reference
Public Member Functions

eLynx::IPlugin Class Reference

Interface defining a plugin. More...

#include <IPlugin.h>

Inheritance diagram for eLynx::IPlugin:
eLynx::Image::IImageFilePlugin eLynx::Image::IImageFilterPlugin

List of all members.

Public Member Functions

virtual const UUIDGetID () const =0
 Get the plugin implementation ID.
virtual const UUIDGetFamilyType () const =0
 Get the plugin family type.
virtual size_t GetVersion () const =0
 Get version of implementation.
virtual const char * GetDescription (size_t iIndex=0) const =0
 Get string description of plugin.

Detailed Description

Interface defining a plugin.

This is the basic description of a plugin.


Member Function Documentation

virtual const char* eLynx::IPlugin::GetDescription ( size_t  iIndex = 0 ) const [pure virtual]

Get string description of plugin.

Parameters:
iIndexThe index of the string to retrieve. For iIndex = 0, must return the plugin name (ex: "OpenGL"), this is name to used with PluginManager::GetPlugin. For iIndex = 1, return the author copyright. For other index value refer to adopted conventions for each plugin family type.
Returns:
A string description.
virtual const UUID& eLynx::IPlugin::GetFamilyType (  ) const [pure virtual]

Get the plugin family type.

Returns:
The UIID that uniquely identify the plugin family type.
virtual const UUID& eLynx::IPlugin::GetID (  ) const [pure virtual]

Get the plugin implementation ID.

Returns:
The UUID that uniquely identify the plugin.
virtual size_t eLynx::IPlugin::GetVersion (  ) const [pure virtual]

Get version of implementation.

Returns:
The version of the plugin.

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

Generated on Thu Dec 9 2010 by doxygen 1.7.2