RemoteExecutionSettingsPlugin Class Reference

#include <RemoteExecution/remoteexecutionsettingsplugin.h>

Inheritance diagram for RemoteExecutionSettingsPlugin:

Public Member Functions
	RemoteExecutionSettingsPlugin ()
Application::PluginConfig &	createPluginConfig () override
DataExecution::DistributedLogSink &	getLogSink ()
QString	getPackageURI () const override
const WorkspacePlugin::PreviousVersionNameMap &	getPreviousNames () const override
bool	setup () override
bool	setupSchedulerProvider (DataExecution::SchedulerProviderManager &manager) 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 RemoteExecutionSettingsPlugin &	getInstance ()

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"
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

Detailed Description

A workspace plugin that provides a user interface for the purposes of managing remote execution settings.

Constructor & Destructor Documentation

RemoteExecutionSettingsPlugin()

RemoteExecutionSettingsPlugin

(

)

Creates the plugin with its name, display name and version.

Member Function Documentation

createPluginConfig()

PluginConfig & createPluginConfig ( )

overridevirtual

This function will be called by clients wanting to create a widget for configuring this plugin. The default implementation creates a widget with simple text indicating that the plugin has no editable configuration items. Those plugins wishing to provide some kind of QWidget-based configuration will need to subclass PluginConfig, but if no configuration is needed then the PluginConfig header file does not need to be included and therefore no reference to QWidget will be made.

Ownership of the instance returned by this function will be given to the caller. At some point, the caller must then call the PluginConfig's destroy() function when it is finished with it.

Returns

A new instance of a PluginConfig object for this plugin.

Reimplemented from WorkspacePlugin.

getInstance()

RemoteExecutionSettingsPlugin & getInstance ( )

static

Returns

The plugin instance.

getLogSink()

DataExecution::DistributedLogSink & getLogSink

(

)

getPackageURI()

QString getPackageURI ( ) const

overridevirtual

Returns

A unique URI that can be used to record the origin of this plugin for provenance recording purposes. This URI should be unique for each platform and released of this plugin.

An example implementation might be: return getName() + "/" + getVersion() + "/" + System::Utilities::getPlatformString() + "/" + System::Utilities::getPlatformArchitectureString();

Reimplemented from WorkspacePlugin.

getPreviousNames()

const WorkspacePlugin::PreviousVersionNameMap & getPreviousNames ( ) const

overridevirtual

Returns

A map of versionNumber -> name, indicating the version at which the plugin stopped using that particular name. e.g. "3.0" -> "www.csiro.au/cfd/workspace" indicates that at version 3.0, the workspace plugin no longer used that name.

Reimplemented from WorkspacePlugin.

setup()

bool setup ( )

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.

Returns

True if successful, false otherwise. If the plugin is being loaded and setup() returns false, the loading of the plugin is assumed to have failed and it will therefore not be available to clients.

See also

setupSchedulerProvider(), setupAuthenticationProvider()

Implements WorkspacePlugin.

setupSchedulerProvider()

bool setupSchedulerProvider ( DataExecution::SchedulerProviderManager &  manager )

overridevirtual

This function will be called by the workspace application when the plugin is loaded. The function must register all schedulers it supplies with calls to manager.addProvider(). Note that this function is the only place where addProvider() should be called (ie never in a plugin's constructor).

Returns

True if successful, false otherwise. If the plugin is being loaded and setupScheduler() returns false, the loading of the plugin is assumed to have failed and it will therefore not be available to clients.

See also

setup(), setupAuthenticationProvider()

Reimplemented from WorkspacePlugin.