Workspace 6.21.5
Public Member Functions | Protected Member Functions | List of all members
SchedulerProvider Class Referenceabstract

The base class of all authentication providers.

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

Inheritance diagram for SchedulerProvider:
[legend]

Public Member Functions

virtual SchedulerConfigurationWidgetcreateConfigurationWidget (AbstractRemoteScheduler &)
 
virtual SchedulerConfigurationWidgetcreateConfigurationWidget (AbstractScheduler &)
 
virtual std::unique_ptr< AbstractRemoteSchedulercreateRemoteScheduler ()
 
virtual std::unique_ptr< AbstractSchedulercreateScheduler ()=0
 
QString getDescription () const
 
QString getName () const
 
virtual QString getTypeId () const =0
 
virtual QString getVersion () const =0
 
virtual bool isUserCreatable () const
 

Protected Member Functions

 SchedulerProvider (const QString &name, const QString &description)
 
virtual ~SchedulerProvider ()
 

Constructor & Destructor Documentation

◆ SchedulerProvider()

SchedulerProvider ( const QString &  name,
const QString &  description 
)
protected

An initialising constructor.

Parameters
nameThe name of the provider
descriptionA description of the provider

◆ ~SchedulerProvider()

~SchedulerProvider ( )
protectedvirtualdefault

Destructor.

Member Function Documentation

◆ createConfigurationWidget() [1/2]

virtual SchedulerConfigurationWidget * createConfigurationWidget ( AbstractRemoteScheduler )
inlinevirtual

◆ createConfigurationWidget() [2/2]

virtual SchedulerConfigurationWidget * createConfigurationWidget ( AbstractScheduler )
inlinevirtual

◆ createRemoteScheduler()

std::unique_ptr< AbstractRemoteScheduler > createRemoteScheduler ( )
virtual

Returns a new instance of remote scheduler.

Returns
The instance, nullptr if no remote scheduler provided by the scheduler provider

Reimplemented in MongoDbSchedulerProvider, SqlSchedulerProvider, and TcpSchedulerProvider.

◆ createScheduler()

virtual std::unique_ptr< AbstractScheduler > createScheduler ( )
pure virtual

◆ getDescription()

QString getDescription ( ) const

Returns a description of the provider.

Returns
SchedulerProvider description.

◆ getName()

QString getName ( ) const

Returns the provider name.

Returns
The name of the provider.

◆ getTypeId()

virtual QString getTypeId ( ) const
pure virtual

◆ getVersion()

virtual QString getVersion ( ) const
pure virtual

◆ isUserCreatable()

virtual bool isUserCreatable ( ) const
inlinevirtual

Reimplemented in OOPSchedulerProvider.