UNIVERS  15.3
UNIVERS base processing software API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Classes | Public Types | Public Member Functions | List of all members
hds::Messenger Class Referenceabstract

#include <hds_messenger.hpp>

Inheritance diagram for hds::Messenger:
hds::MessengerFile hds::MessengerLS hds::MessengerStd

Classes

struct  Message
 

Public Types

enum  MsgType {
  UNDEFINED_MSG = 0, INFO_MSG, WARNING_MSG, ERROR_MSG,
  DEBUG_MSG, SHOW_PROGRESS_MSG, HIDE_PROGRESS_MSG, SET_PROGRESS_VALUE_MSG,
  SET_PROGRESS_RANGES_MSG, SET_PROGRESS_STATUS_MSG
}
 

Public Member Functions

 Messenger ()
 
virtual ~Messenger ()
 
virtual void sendMsg (const Message &msg) const =0
 
virtual Message getMsg () const =0
 
void info (const QString &str) const
 
void warning (const QString &str) const
 
void error (const QString &str) const
 
void debug (const QString &str) const
 

Detailed Description

Interface for messaging processing.

Member Enumeration Documentation

Type of the message. (qint32 used in local sockets)

Enumerator
UNDEFINED_MSG 

Message with undefined type.

INFO_MSG 

Info string message.

WARNING_MSG 

Warning string message.

ERROR_MSG 

Error string message.

DEBUG_MSG 

Debug string message.

SHOW_PROGRESS_MSG 

Show progress message.

HIDE_PROGRESS_MSG 

Hide progress message.

SET_PROGRESS_VALUE_MSG 

Set progress current value.

SET_PROGRESS_RANGES_MSG 

Set ranges for progress.

SET_PROGRESS_STATUS_MSG 

Set status for progress.

Constructor & Destructor Documentation

hds::Messenger::Messenger ( )

Default constructor.

virtual hds::Messenger::~Messenger ( )
virtual

Destructor.

Member Function Documentation

void hds::Messenger::debug ( const QString &  str) const
inline

Send log message.

void hds::Messenger::error ( const QString &  str) const
inline

Send error message.

virtual Message hds::Messenger::getMsg ( ) const
pure virtual
Get first message with it's type, return message of undefined type  

if no messages presents. Content of the message should be defined in compliance with the type.

Implemented in hds::MessengerLS, hds::MessengerFile, and hds::MessengerStd.

void hds::Messenger::info ( const QString &  str) const
inline

Send info message.

virtual void hds::Messenger::sendMsg ( const Message msg) const
pure virtual
Send message with provided type. Content of the message 

should be defined in compliance with the type.

Implemented in hds::MessengerLS, hds::MessengerFile, and hds::MessengerStd.

void hds::Messenger::warning ( const QString &  str) const
inline

Send warning message.


The documentation for this class was generated from the following file: