Workspace 6.21.5
Public Member Functions | Protected Member Functions | List of all members
WorkspaceLogMessage Class Reference

Represents a message sent by a remote scheduler to a workspace client indicating that an operation in the remote workspace has notified a log message.

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

Inheritance diagram for WorkspaceLogMessage:
[legend]

Public Member Functions

 WorkspaceLogMessage ()
 
 WorkspaceLogMessage (const QString &uuid, const QString &logText)
 
 ~WorkspaceLogMessage () override
 
const QString & getLogText () const
 
quint32 getMessageTypeId () const override
 
bool readMessageDataFrom (QDataStream &) override
 
- 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 &)
 

Protected Member Functions

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

◆ WorkspaceLogMessage() [1/2]

WorkspaceLogMessage ( )
default

◆ WorkspaceLogMessage() [2/2]

WorkspaceLogMessage ( const QString &  uuid,
const QString &  logText 
)

◆ ~WorkspaceLogMessage()

~WorkspaceLogMessage ( )
overridedefault

Member Function Documentation

◆ getLogText()

const QString & getLogText ( ) const

◆ getMessageTypeId()

quint32 getMessageTypeId ( ) const
overridevirtual

Returns the message's type identifier.

Reimplemented from TcpMessage.

◆ readMessageDataFrom()

bool readMessageDataFrom ( QDataStream &  stream)
overridevirtual
Parameters
streamthe stream from which a WorkspaceTcpMessage's data is to be read.
Returns
true if read successfully, otherwise false.

Reads a WorkspaceLogMessage's data from a stream.

Reimplemented from SchedulerTcpMessage.

◆ writeMessageDataTo()

void writeMessageDataTo ( QDataStream &  messageDataStream)
overrideprotectedvirtual
Parameters
messageDataStreamthe stream to which a WorkspaceTcpMessage's data is written.

Writes a WorkspaceLogMessage's data to a stream.

Reimplemented from SchedulerTcpMessage.