Workspace 6.21.5
Public Member Functions | List of all members
DefaultOutputStream< VerboseOpLinks > Class Template Reference

A default output stream which writes log messages to the std::ostream supplied to it. More...

#include <Workspace/DataExecution/Logging/defaultlogstream.h>

Inheritance diagram for DefaultOutputStream< VerboseOpLinks >:
[legend]

Public Member Functions

 DefaultOutputStream (std::ostream &internalStream)
 
void sendText (const QString &msg, const QDateTime &)
 
void sendText (const QString &msg, const QDateTime &)
 
void sendText (const QString &msg, const QDateTime &) override
 
- Public Member Functions inherited from DefaultOutputStreamBase
 DefaultOutputStreamBase (std::ostream &internalStream)
 
void flush () override
 
std::ostream & getInternalStream ()
 
bool isStreamOkay () const override
 
void setInternalStream (std::ostream &stream)
 
- Public Member Functions inherited from LogStream
virtual ~LogStream ()
 
virtual void flush ()=0
 
virtual bool isStreamOkay () const =0
 
void logText (const QString &msg, const QDateTime &timestamp)
 

Detailed Description

template<bool VerboseOpLinks>
class CSIRO::DataExecution::DefaultOutputStream< VerboseOpLinks >
Template Parameters
VerboseOpLinksIf true, the stream will not filter any operation links (
See also
DataExecution::linkInLogText) from incoming text. If false, the stream will identify any linkInLogText() calls, and alter them so that they display only the label.

Constructor & Destructor Documentation

◆ DefaultOutputStream()

DefaultOutputStream ( std::ostream &  internalStream)
inline

Member Function Documentation

◆ sendText() [1/3]

void sendText ( const QString &  msg,
const QDateTime &   
)
inlinevirtual
Parameters
msgThe text to be sent to the stream.

This function is called by logText() with the expectation that msg will be sent to the relevant place by the subclass' implementation. Please override this only.

Reimplemented from LogStream.

◆ sendText() [2/3]

void sendText ( const QString &  msg,
const QDateTime &   
)
inlinevirtual
Parameters
msgThe text to be sent to the stream.

This function is called by logText() with the expectation that msg will be sent to the relevant place by the subclass' implementation. Please override this only.

Reimplemented from LogStream.

◆ sendText() [3/3]

void sendText ( const QString &  msg,
const QDateTime &   
)
overridevirtual
Parameters
msgThe text to be sent to the stream.

This function is called by logText() with the expectation that msg will be sent to the relevant place by the subclass' implementation. Please override this only.

Reimplemented from LogStream.