Workspace 6.21.5
|
WorkspacePlugin singleton class for this module.
#include <DataAnalysis/dataanalysisplugin.h>
Public Member Functions | |
QStringList | getCustomWidgetPaths () const override |
QString | getPackageURI () const override |
const WorkspacePlugin::PreviousVersionNameMap & | getPreviousNames () const override |
virtual ScriptLibraryRegistry & | getScriptLibraryRegistry () |
bool | setup () override |
Public Member Functions inherited from WorkspacePlugin | |
WorkspacePlugin (const QString &name, const QString &displayName, const QString &version, const QString &buildDescription=QString::null) | |
WorkspacePlugin (const QString &name, const QString &displayName, int versionMajor, int versionMinor, int versionRevision, const QString &buildDescription=QString::null) | |
virtual | ~WorkspacePlugin () |
virtual PluginConfig & | createPluginConfig () |
virtual PluginMenu & | createPluginMenu () |
const QString & | getBuildDescription () const |
virtual QStringList | getCustomWidgetPaths () const |
virtual const DataExecution::DataFactory * | getDataFactory (const QString &dataType) const |
const DataExecution::DataFactory * | getDataFactory (size_type index) const |
virtual QString | getDefaultHelpPagePath () const |
virtual QString | getDefaultIconPath () const |
virtual WorkspacePluginList | getDependencies () const |
const QString & | getDisplayName () const |
virtual QString | getHelpFile () const |
const QString & | getLibraryFileName () const |
virtual QStringList | getLicensePaths () const |
const QString & | getName () const |
size_type | getNumDataFactories () const |
size_type | getNumOperationFactories () const |
size_type | getNumWidgetFactories () const |
virtual const DataExecution::OperationFactory * | getOperationFactory (const QString &opType, bool ignoreAliasedOperations=false) const |
const DataExecution::OperationFactory * | getOperationFactory (size_type index) const |
virtual QString | getPackageURI () const |
virtual const PreviousVersionNameMap & | getPreviousNames () const |
const QString & | getVersion () const |
const Widgets::WidgetFactory * | getWidgetFactory (size_type index) const |
virtual bool | isVisible () const |
void | logText (const QString &message) |
virtual void | onWorkspaceClose () |
void | setLibraryFileName (const QString &fileName) |
virtual bool | setup ()=0 |
virtual bool | setupAuthenticationProvider (Authentication::ProviderManager &manager) |
virtual bool | setupSchedulerProvider (DataExecution::SchedulerProviderManager &manager) |
void | showHelp (const QMap< QString, QUrl > &links, const QString &keyword="") |
void | showHelp (const QString &keyword) |
void | showHelp (const QUrl &url) |
bool | wasPreviouslyNamed (const QString &oldName) const |
Static Public Member Functions | |
static DataAnalysisPlugin & | getInstance () |
Protected Member Functions | |
const DataExecution::DataFactory * | getAliasedDataFactory (const QString &dataType) const override |
const DataExecution::OperationFactory * | getAliasedOperationFactory (const QString &opType) const override |
Protected Member Functions inherited from WorkspacePlugin | |
bool | addFactory (const DataExecution::DataFactory &factory) |
bool | addFactory (const DataExecution::OperationFactory &factory) |
bool | addFactory (const DataExecution::TypeAdaptorFactory &factory, bool replaceExisting=false) |
bool | addFactory (const Widgets::WidgetFactory &factory) |
bool | addTranslation (const QString &fileName="") |
void | addWorkspaceCollection (const QString &location) |
const DataExecution::DataFactory * | forwardDataFactoryRequest (const QString &pluginName, const QString &dataType) const |
const DataExecution::OperationFactory * | forwardOperationFactoryRequest (const QString &pluginName, const QString &opType) const |
virtual const DataExecution::DataFactory * | getAliasedDataFactory (const QString &dataType) const |
virtual const DataExecution::OperationFactory * | getAliasedOperationFactory (const QString &opType) const |
Additional Inherited Members | |
Public Types inherited from WorkspacePlugin | |
using | PreviousVersionNameMap = QMap< QString, QString > |
using | size_type = size_t |
using | WorkspacePluginList = QList< WorkspacePlugin * > |
Static Public Attributes inherited from WorkspacePlugin | |
static const QString | DEFAULT_ICON_PATH = "images:/Workspace/core/operation_icon.png" |
|
overrideprotectedvirtual |
dataType | Name of a data type. |
If a data type is renamed, this function provides a backwards compatibility mechanism so that the plugin can provide the new factory that corresponds to an old name. By default, this function returns a null pointer, but subclasses can override it to provide an appropriate factory if a data type is renamed. Note that this function is only called by getDataFactory() if it could not find the factory from the plugin directly. Subclasses can assume that the request for dataType will only be made when the plugin has already been correctly identified by name (ie no functionality is provided for renaming a plugin).
Reimplemented from WorkspacePlugin.
|
overrideprotectedvirtual |
opType | Name of an operation. |
If an operation is renamed, this function provides a backwards compatibility mechanism so that the plugin can provide the new factory that corresponds to an old name. By default, this function returns a null pointer, but subclasses can override it to provide an appropriate factory if an operation is renamed. Note that this function is only called by getOperationFactory() if it could not find the factory from the operation factory manager. Subclasses can assume that the request for opType will only be made when the plugin has already been correctly identified by name (ie no functionality is provided for renaming a plugin).
Reimplemented from WorkspacePlugin.
|
overridevirtual |
The custom widget paths would normally be specified using the "widgets" resource search path. A typical example would be something like widgets:MyPluginPath
where MyPluginPath
would be an area below which you put all your plugin's custom widget .ui files
. If you use the widgets:
prefix instead of just an ordinary (absolute or relative) file path, then the paths you specify will be interpretted as being relative to the application's default search paths. This is normally what you want, since plugins should generally install their custom .ui
files in their own directory below the common widgets
directory in the install area. This directory structuring is used by both the widget style sheets (in the styles
directory) and by the custom widget .ui
files.
If you follow the directory structure recommended above, then your .ui files should be found without having to do anything else. When a plugin is loaded by the PluginManager, it looks at the directory in which the plugin was located and it searches for a widgets directory related to that location. See PluginManager::loadPlugin() for more details about this directory structure.
Reimplemented from WorkspacePlugin.
|
static |
The first call to this function is not thread-safe, since it creates the plugin instance. All subsequent calls are then thread-safe. Given that the workspace application will call this function on startup when only one thread is active, client code can therefore call this function with the assumption that it is thread-safe.
|
overridevirtual |
An example implementation might be: return getName() + "/" + getVersion() + "/" + System::Utilities::getPlatformString() + "/" + System::Utilities::getPlatformArchitectureString();
Reimplemented from WorkspacePlugin.
|
overridevirtual |
Reimplemented from WorkspacePlugin.
|
virtual |
Access the internal script library registry tied to this plugin.
|
overridevirtual |
This function will be called by the workspace application when the plugin is loaded. The function must register all factories it supplies (operations, data objects, etc.) with calls to addFactory(). Note that this function is the only place where addFactory() should be called (ie never in a plugin's constructor). A plugin may also do any other processing it requires in setup() before the plugin is used.
Implements WorkspacePlugin.