SchedulerProviderManager Class Reference

Maintains a list of scheduler providers. More...

#include <Workspace/DataExecution/Execution/schedulerprovidermanager.h>

Public Member Functions
void	addProvider (SchedulerProvider &)
int	count () const
std::unique_ptr< AbstractScheduler >	createByTypeId (const QString &typeId)
std::unique_ptr< AbstractRemoteScheduler >	createRemoteSchedulerByTypeId (const QString &typeId)
bool	empty () const
SchedulerProvider *	getByTypeId (const QString &typeId) const
void	load (const QStringList &paths)
SchedulerProvider &	operator[] (int index)
void	removeProvider (SchedulerProvider &)

Static Public Member Functions
static QString	getDefaultSchedulerTypeId ()
static QString	getFrameworkVersion ()
static SchedulerProviderManager &	getInstance ()

Detailed Description

See also

SchedulerProvider

Member Function Documentation

addProvider()

void addProvider

(

SchedulerProvider &

provider

)

Register a SchedulerProvider to Workspace. This should be called in a plugin's setupSchedulerProvider() method.

Parameters

provider

The SchedulerProvider to add.

See also

WorkspacePlugin::setupSchedulerProvider(), SchedulerProviderManager::removeProvider()

count()

int count

(

)

const

Returns a count of the SchedulerProviders in the collection.

Returns

A count of SchedulerProviders in the collection.

createByTypeId()

std::unique_ptr< AbstractScheduler > createByTypeId

(

const QString &

typeId

)

Creates a scheduler of the specified type.

Returns

A scheduler of the specified type.

createRemoteSchedulerByTypeId()

std::unique_ptr< AbstractRemoteScheduler > createRemoteSchedulerByTypeId

(

const QString &

typeId

)

Creates a remote scheduler of the specified type.

Returns

A remote scheduler of the specified type.

empty()

bool empty

(

)

const

Indicates if the SchedulerProvider collection is empty or not.

Returns

Returns true if the provider collection is empty.

getByTypeId()

SchedulerProvider * getByTypeId

(

const QString &

typeId

)

const

Returns the provider with the specified name or null if none exists.

Returns

A provider with the specified name.

getDefaultSchedulerTypeId()

QString getDefaultSchedulerTypeId ( )

static

getFrameworkVersion()

QString getFrameworkVersion ( )

static

Returns the version of the scheduler framework.

Returns

The scheduler framework version.

getInstance()

SchedulerProviderManager & getInstance ( )

static

Returns the singleton instance of the SchedulerProviderManager.

Returns

Singleton instance of the SchedulerProviderManager.

load()

void load

(

const QStringList &

paths

)

Used to load all installed providers. Now it's deprecated.

Parameters

paths

A list of paths to scan for scheduler providers.

See also

SchedulerProviderManager::addProvider(SchedulerProvider&), SchedulerProviderManager::removeProvider(SchedulerProvider&)

operator[]()

SchedulerProvider & operator[]

(

int

index

)

Returns the SchedulerProvider at the provided index.

Returns

Returns the provider at the specified index.

removeProvider()

void removeProvider

(

SchedulerProvider &

provider

)

Remove a SchedulerProvider to Workspace. This should be called from the SchedulerProvider's destructor.

Parameters

provider

The SchedulerProvider to remove.

See also

SchedulerProviderManager::addProvider()