ScheduleWorkspaceExecutionMessage Class Reference

Use this message to schedule the execution of a workspace on a remote machine.

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

Inheritance diagram for ScheduleWorkspaceExecutionMessage:

Public Member Functions
	ScheduleWorkspaceExecutionMessage ()
	ScheduleWorkspaceExecutionMessage (Workspace *)
	~ScheduleWorkspaceExecutionMessage () override
bool	getDebugWithGui () const
QMap< QString, bool >	getLogMessageCategoryMap () const
quint32	getMessageTypeId () const override
QStringList	getNotifyMailRecipients () const
bool	getProfiling () const
bool	getUsedPluginsOnly () const
bool	readMessageDataFrom (QDataStream &) override
void	setDebugWithGui (bool debugWithGui)
void	setLogMessageCategoryMap (const QMap< QString, bool > &map)
void	setNotifyMailRecipients (const QStringList &list)
void	setProfiling (bool profiling)
void	setUsedPluginsOnly (bool usedPluginsOnly)
Public Member Functions inherited from WorkspaceTcpMessage
	WorkspaceTcpMessage ()
	WorkspaceTcpMessage (Workspace *)
	~WorkspaceTcpMessage () override
Workspace *	getWorkspace ()
bool	readMessageDataFrom (QDataStream &) override
void	setOwnsWorkspace (bool)
Public Member Functions inherited from SchedulerTcpMessage
	SchedulerTcpMessage ()
	SchedulerTcpMessage (const QString &)
	~SchedulerTcpMessage () override
const QString &	getAuthenticationFrameworkVersion () const
const QString &	getAuthenticationProvider () const
const QString &	getAuthenticationProviderVersion () const
const QString &	getCredentials () const
const QString &	getMessageToken () const
const QString &	getSchedulerVersion () const
const QString &	getUuid ()
bool	readMessageDataFrom (QDataStream &) override
void	setAuthenticationProvider (const QString &)
void	setAuthenticationProviderVersion (const QString &)
void	setCredentials (const QString &)
void	setMessageToken (const QString &)
void	setSchedulerVersion (const QString &)
void	setUuid (const QString &)
Public Member Functions inherited from TcpMessage
	TcpMessage ()
	TcpMessage (const TcpMessage &rhs)
virtual	~TcpMessage ()
quint32	getLength () const
const QByteArray &	getMessageData () const
virtual quint32	getMessageTypeId () const
bool	hasBeenFullyRead () const
TcpMessage &	operator= (const TcpMessage &)
void	readFrom (QIODevice &)
virtual bool	readMessageDataFrom (QDataStream &)
void	writeTo (QIODevice &)

Protected Member Functions
void	writeMessageDataTo (QDataStream &) override
Protected Member Functions inherited from WorkspaceTcpMessage
void	writeMessageDataTo (QDataStream &) override
void	writeMessageDataTo (QDataStream &) override
virtual void	writeMessageDataTo (QDataStream &)

Additional Inherited Members
Static Public Member Functions inherited from TcpMessage
static void	configureStream (QDataStream &)
Protected Attributes inherited from SchedulerTcpMessage
QString	authenticationFrameworkVersion_
QString	authenticationProvider_
QString	authenticationProviderVersion_
QString	credentials_
QString	messageToken_
QString	schedulerVersion_
QString	uuid_

Constructor & Destructor Documentation

ScheduleWorkspaceExecutionMessage() [1/2]

ScheduleWorkspaceExecutionMessage ( )

default

ScheduleWorkspaceExecutionMessage() [2/2]

ScheduleWorkspaceExecutionMessage ( Workspace *  workspace )

explicit

~ScheduleWorkspaceExecutionMessage()

~ScheduleWorkspaceExecutionMessage ( )

overridedefault

Member Function Documentation

getDebugWithGui()

bool getDebugWithGui ( ) const

inline

getLogMessageCategoryMap()

QMap< QString, bool > getLogMessageCategoryMap ( ) const

inline

getMessageTypeId()

quint32 getMessageTypeId ( ) const

overridevirtual

Returns the message's type identifier.

Reimplemented from TcpMessage.

getNotifyMailRecipients()

QStringList getNotifyMailRecipients ( ) const

inline

getProfiling()

bool getProfiling ( ) const

inline

getUsedPluginsOnly()

bool getUsedPluginsOnly ( ) const

inline

readMessageDataFrom()

bool readMessageDataFrom ( QDataStream &  stream )

overridevirtual

Reads a ScheduleWorkspaceExecutionMessage's data from a stream.

Parameters

stream

the stream from which a ScheduleWorkspaceExecutionMessage's data is to be read.

Reimplemented from SchedulerTcpMessage.

setDebugWithGui()

void setDebugWithGui ( bool  debugWithGui )

inline

setLogMessageCategoryMap()

void setLogMessageCategoryMap ( const QMap< QString, bool > &  map )

inline

setNotifyMailRecipients()

void setNotifyMailRecipients ( const QStringList &  list )

inline

setProfiling()

void setProfiling ( bool  profiling )

inline

setUsedPluginsOnly()

void setUsedPluginsOnly ( bool  usedPluginsOnly )

inline

writeMessageDataTo()

void writeMessageDataTo ( QDataStream &  messageDataStream )

overrideprotectedvirtual

Writes a ScheduleWorkspaceExecutionMessage's data to a stream.

Parameters

messageDataStream

the stream to which a ScheduleWorkspaceExecutionMessage's data is written.

Reimplemented from SchedulerTcpMessage.