Workspace 6.21.5
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
WorkspaceListMessage Class Reference

Message reply with a list of Workspace in queue.

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

Inheritance diagram for WorkspaceListMessage:
[legend]

Public Member Functions

 WorkspaceListMessage ()
 
 ~WorkspaceListMessage () override
 
void addWorkspace (const WorkspaceBrief &wb)
 
void addWorkspace (Workspace &, const QString &client, const QString &user, const QDateTime &addTime, const QDateTime &executionBeginTime, const QDateTime &executionEndTime, const QString &sessionId, bool aborted)
 
int count () const
 
quint32 getMessageTypeId () const override
 
bool isSchedulerPaused () const
 
const QList< WorkspaceBrief > & list () const
 
void reset ()
 
void setSchedulerPaused (bool paused)
 
- 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
 
TcpMessageoperator= (const TcpMessage &)
 
void readFrom (QIODevice &)
 
virtual bool readMessageDataFrom (QDataStream &)
 
void writeTo (QIODevice &)
 

Static Public Member Functions

static WorkspaceBrief briefFrom (Workspace &, const QString &client, const QString &user, const QDateTime &addTime, const QDateTime &executionBeginTime, const QDateTime &executionEndTime, const QString &sessionId, bool isSchedulerPaused, bool aborted)
 
- Static Public Member Functions inherited from TcpMessage
static void configureStream (QDataStream &)
 

Protected Member Functions

bool readMessageDataFrom (QDataStream &) override
 
void writeMessageDataTo (QDataStream &) override
 
- Protected Member Functions inherited from SchedulerTcpMessage
void writeMessageDataTo (QDataStream &) override
 
virtual void writeMessageDataTo (QDataStream &)
 

Protected Attributes

bool isSchedulerPaused_
 
QList< WorkspaceBrieflist_
 
QDateTime timeStamp_
 
- Protected Attributes inherited from SchedulerTcpMessage
QString authenticationFrameworkVersion_
 
QString authenticationProvider_
 
QString authenticationProviderVersion_
 
QString credentials_
 
QString messageToken_
 
QString schedulerVersion_
 
QString uuid_
 

Constructor & Destructor Documentation

◆ WorkspaceListMessage()

◆ ~WorkspaceListMessage()

~WorkspaceListMessage ( )
overridedefault

Member Function Documentation

◆ addWorkspace() [1/2]

void addWorkspace ( const WorkspaceBrief wb)

◆ addWorkspace() [2/2]

void addWorkspace ( Workspace workspace,
const QString &  client,
const QString &  user,
const QDateTime &  addTime,
const QDateTime &  executionBeginTime,
const QDateTime &  executionEndTime,
const QString &  sessionId,
bool  aborted 
)

◆ briefFrom()

WorkspaceBrief briefFrom ( Workspace workspace,
const QString &  client,
const QString &  user,
const QDateTime &  addTime,
const QDateTime &  executionBeginTime,
const QDateTime &  executionEndTime,
const QString &  sessionId,
bool  isSchedulerPaused,
bool  aborted 
)
static

◆ count()

int count ( ) const
inline

◆ getMessageTypeId()

quint32 getMessageTypeId ( ) const
overridevirtual

Returns the message's type identifier.

Reimplemented from TcpMessage.

◆ isSchedulerPaused()

bool isSchedulerPaused ( ) const
inline

◆ list()

const QList< WorkspaceBrief > & list ( ) const
inline

◆ readMessageDataFrom()

bool readMessageDataFrom ( QDataStream &  stream)
overrideprotectedvirtual

This method should be overridden in TcpMessage derived messages to provide message specific reading.

See also
writeMessageDataTo()

Reimplemented from TcpMessage.

◆ reset()

void reset ( )

◆ setSchedulerPaused()

void setSchedulerPaused ( bool  paused)

◆ writeMessageDataTo()

void writeMessageDataTo ( QDataStream &  stream)
overrideprotectedvirtual

This method should be overridden in TcpMessage derived messages to provide message specific writing.

See also
readMessageDataFrom()

Reimplemented from TcpMessage.

Member Data Documentation

◆ isSchedulerPaused_

bool isSchedulerPaused_
protected

◆ list_

QList<WorkspaceBrief> list_
protected

◆ timeStamp_

QDateTime timeStamp_
protected