eLynx::IPlugin Class Reference
#include <IPlugin.h>
Inheritance diagram for eLynx::IPlugin:
Public Member Functions | |
| virtual | ~IPlugin () |
| virtual const UUID & | GetID () const =0 |
| virtual const UUID & | GetFamilyType () const =0 |
| virtual size_t | GetVersion () const =0 |
| virtual const char * | GetDescription (size_t iIndex=0) const =0 |
Detailed Description
Interface defining a plugin.This is the basic description of a plugin.
Definition at line 44 of file IPlugin.h.
Constructor & Destructor Documentation
| virtual eLynx::IPlugin::~IPlugin | ( | ) | [virtual] |
Member Function Documentation
| virtual const UUID& eLynx::IPlugin::GetID | ( | ) | const [pure virtual] |
Get the plugin implementation ID.
- Returns:
- The UUID that uniquely identify the plugin.
| 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 size_t eLynx::IPlugin::GetVersion | ( | ) | const [pure virtual] |
Get version of implementation.
- Returns:
- The version of the plugin.
| virtual const char* eLynx::IPlugin::GetDescription | ( | size_t | iIndex = 0 |
) | const [pure virtual] |
Get string description of plugin.
- Parameters:
-
iIndex The 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.
The documentation for this class was generated from the following file: