All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines
Abstract interface for all Geopsy plugins. More...
#include <GeopsyCoreInterface.h>
Public Member Functions | |
| virtual QString | description () const |
| virtual const char * | interfaceVersion () const =0 |
| bool | isValid () const |
| virtual void | polish () |
| virtual QString | tag () const =0 |
| virtual QString | title () const =0 |
| virtual | ~GeopsyCoreInterface () |
Abstract interface for all Geopsy plugins.
The constructor of a new plugin is the right place to add custom file formats. At the constructor time, the current data base and the signal cache are not initialized. Reimplement polish() if you need these two elements to be initialized.
| virtual GeopsyCore::GeopsyCoreInterface::~GeopsyCoreInterface | ( | ) | [inline, virtual] |
{}
| QString GeopsyCore::GeopsyCoreInterface::description | ( | ) | const [virtual] |
Return a complete description of the plugin. By default, it returns a null string.
Reimplemented in Plugin.
{
return QString::null;
}
| const char * GeopsyCore::GeopsyCoreInterface::interfaceVersion | ( | ) | const [pure virtual] |
Returns the geopsycore version of the plugin (at compile time)
Implemented in ToolSeparator, StructureRatiosPlugin, HVPlugin, ArrayPlugin, DampingPlugin, NRPlugin, PtMotionPlugin, RefraPlugin, TFAPlugin, and Plugin.
Referenced by isValid(), and GeopsyCore::GeopsyPlugins::load().
| bool GeopsyCore::GeopsyCoreInterface::isValid | ( | ) | const |
Check if the plugin version is compatible with the current core
References QGpCoreTools::Version::compatible(), and interfaceVersion().
Referenced by GeopsyCore::GeopsyPlugins::getList().
{
static const Version vRef(GEOPSYCORE_VERSION);
Version v(interfaceVersion());
return v.compatible(vRef);
}
| virtual void GeopsyCore::GeopsyCoreInterface::polish | ( | ) | [inline, virtual] |
Referenced by GeopsyCore::GeopsyPlugins::polish().
{}
| virtual QString GeopsyCore::GeopsyCoreInterface::tag | ( | ) | const [pure virtual] |
Implemented in ToolSeparator, StructureRatiosPlugin, HVPlugin, ArrayPlugin, DampingPlugin, NRPlugin, PtMotionPlugin, RefraPlugin, TFAPlugin, and Plugin.
Referenced by ToolFactory::infoTools(), and ToolFactory::tool().
| virtual QString GeopsyCore::GeopsyCoreInterface::title | ( | ) | const [pure virtual] |
Implemented in ToolSeparator, StructureRatiosPlugin, HVPlugin, ArrayPlugin, DampingPlugin, NRPlugin, PtMotionPlugin, RefraPlugin, TFAPlugin, and Plugin.
