MessageService Class Reference

The service to collect messages from different senders. More...

Public Member Functions
virtual	~MessageService ()
void	clear ()
int	errorCount (const QObject *sender=0) const
	Returns number of errors for given sender. More...
QStringList	errorDescriptionList (const QObject *sender=0) const
	Returns multi-line string representing error messages of given sender. More...
int	messageCount (const QObject *sender, const QString &message_type="") const
	Reports number of messages of given type reported by the sender. More...
const QList< GUIMessage * >	messages () const
void	send_error (QObject *sender, const QString &description)
void	send_message (QObject *sender, const QString &message_type, const QString &description)
void	send_warning (QObject *sender, const QString &description)
QStringList	senderList () const
int	warningCount (const QObject *sender=0) const
	Returns number of warnings for given sender. More...

Private Attributes
QList< GUIMessage * >	m_messages

Detailed Description

The service to collect messages from different senders.

Definition at line 28 of file MessageService.h.

Constructor & Destructor Documentation

~MessageService()

MessageService::~MessageService ( )

virtual

Definition at line 25 of file MessageService.cpp.

{
    clear();
}

References clear().

Here is the call graph for this function:

Member Function Documentation

clear()

void MessageService::clear

(

)

Definition at line 30 of file MessageService.cpp.

{
    for (auto message : m_messages)
        delete message;
 
    m_messages.clear();
}

References m_messages.

Referenced by ~MessageService(), and ProjectManager::createNewProject().

errorCount()

int MessageService::errorCount

(

const QObject *

sender = 0

)

const

Returns number of errors for given sender.

If sender is nullptr, report total number of errors.

Definition at line 105 of file MessageService.cpp.

{
    return messageCount(sender, message_error_type);
}

References messageCount().

Here is the call graph for this function:

errorDescriptionList()

QStringList MessageService::errorDescriptionList

(

const QObject *

sender = 0

)

const

Returns multi-line string representing error messages of given sender.

Definition at line 112 of file MessageService.cpp.

{
    QStringList result;
 
    for (auto message : messages())
        if (message->sender() == sender && message->messageType() == message_error_type)
            result.push_back(message->messageDescription());
 
    return result;
}

References messages().

Referenced by ProjectManager::riseProjectLoadFailedDialog().

Here is the call graph for this function:

messageCount()

int MessageService::messageCount	(	const QObject *	sender,
		const QString &	message_type = ""
	)		const

Reports number of messages of given type reported by the sender.

If message_type.isEmpty, count all messages of given sender.

Definition at line 75 of file MessageService.cpp.

{
    int result(0);
    for (auto message : messages())
        if (sender && message->sender() == sender) {
            if (message_type.isEmpty())
                ++result;
            else if (message->messageType() == message_type)
                ++result;
        } else if (sender == nullptr) {
            if (message_type.isEmpty())
                ++result;
            else if (message->messageType() == message_type)
                ++result;
        }
 
    return result;
}

References messages().

Referenced by errorCount(), ProjectDocument::readFrom(), and warningCount().

Here is the call graph for this function:

messages()

const QList< GUIMessage * > MessageService::messages

(

)

const

Definition at line 54 of file MessageService.cpp.

{
    return m_messages;
}

References m_messages.

Referenced by ProjectLoadWarningDialog::createTableWidget(), errorDescriptionList(), messageCount(), ProjectLoadWarningDialog::numberOfTableRows(), and senderList().

send_error()

void MessageService::send_error	(	QObject *	sender,
		const QString &	description
	)

Definition at line 44 of file MessageService.cpp.

{
    send_message(sender, message_error_type, description);
}

References send_message().

Referenced by ProjectDocument::load(), and ProjectDocument::readFrom().

Here is the call graph for this function:

send_message()

void MessageService::send_message	(	QObject *	sender,
		const QString &	message_type,
		const QString &	description
	)

Definition at line 38 of file MessageService.cpp.

{
    m_messages.append(new GUIMessage(sender, message_type, description));
}

References m_messages.

Referenced by send_error(), and send_warning().

send_warning()

void MessageService::send_warning	(	QObject *	sender,
		const QString &	description
	)

Definition at line 49 of file MessageService.cpp.

{
    send_message(sender, message_warning_type, description);
}

References send_message().

Referenced by OutputDataIOService::load().

Here is the call graph for this function:

senderList()

QStringList MessageService::senderList

(

)

const

Definition at line 59 of file MessageService.cpp.

{
    QSet<QString> set;
    for (auto message : messages())
        set.insert(message->senderName());
 
#if QT_VERSION >= QT_VERSION_CHECK(5, 14, 0)
    return set.values();
#else
    return set.toList();
#endif
}

References messages().

Referenced by ProjectLoadWarningDialog::createModelInfoPanel().

Here is the call graph for this function:

warningCount()

int MessageService::warningCount

(

const QObject *

sender = 0

)

const

Returns number of warnings for given sender.

If sender is nullptr, report total number of warnings.

Definition at line 97 of file MessageService.cpp.

{
    return messageCount(sender, message_warning_type);
}

References messageCount().

Referenced by ProjectDocument::load().

Here is the call graph for this function:

Member Data Documentation

m_messages

QList<GUIMessage*> MessageService::m_messages

private

Definition at line 49 of file MessageService.h.

Referenced by clear(), messages(), and send_message().

---

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

• /home/www/ba/GUI/coregui/utils/MessageService.h
• /home/www/ba/GUI/coregui/utils/MessageService.cpp