QtPdCom::Message Class Reference

Process message. More...

#include <Message.h>

Inheritance diagram for QtPdCom::Message:

Collaboration diagram for QtPdCom::Message:

Classes
struct	Exception
	Exception type. More...
class	Impl

Public Types
enum	Type { Information, Warning, Error, Critical }
	Message type. More...

Signals
void	stateChanged ()

Public Member Functions
	Q_ENUM (Type)
	Message (QObject *parent=nullptr)
	Constructor. More...
	~Message ()
	Destructor. More...
bool	isActive () const
double	getTime () const
Type	getType () const
const QString &	getPath () const
int	getIndex () const
QString	getText (const QString &=QString()) const
QString	getDescription (const QString &=QString()) const
QString	getTimeString () const
	Returns the message time as a string. More...

Private Attributes
class Q_DECL_HIDDEN	Impl
std::unique_ptr< Impl >	impl

Friends
class	MessageModel

Detailed Description

Process message.

Member Enumeration Documentation

Type

enum QtPdCom::Message::Type

Message type.

Enumerator
Information	Non-critical information.
Warning	Warning, that does not influence the process flow.
Error	Error, that influences the process flow.
Critical	Critical error, that makes the process unable to run.

Constructor & Destructor Documentation

Message()

QtPdCom::Message::Message

(

QObject *

parent = nullptr

)

Constructor.

~Message()

QtPdCom::Message::~Message

(

)

Destructor.

Member Function Documentation

getDescription()

QString QtPdCom::Message::getDescription

(

const QString &

lang = QString()

)

const

Returns

The message description.

References impl.

getIndex()

int QtPdCom::Message::getIndex

(

)

const

Returns

The message index.

References impl.

Referenced by QtPdCom::MessageModel::connect(), and QtPdCom::MessageModel::Impl::stateChanged().

getPath()

const QString & QtPdCom::Message::getPath

(

)

const

Returns

The message path.

References impl.

Referenced by QtPdCom::MessageModel::connect(), and QtPdCom::MessageModel::Impl::stateChanged().

getText()

QString QtPdCom::Message::getText

(

const QString &

lang = QString()

)

const

Returns

The message text. If the text is not available in the desired language, the default text (empty language) will be returned.

References impl.

getTime()

double QtPdCom::Message::getTime

(

)

const

Returns

The message time in seconds.

References impl.

getTimeString()

QString QtPdCom::Message::getTimeString

(

)

const

Returns the message time as a string.

References impl.

getType()

Message::Type QtPdCom::Message::getType

(

)

const

Returns

The message type.

References impl.

isActive()

bool QtPdCom::Message::isActive

(

)

const

Returns

True, if the message is currently active.

References impl.

Q_ENUM()

QtPdCom::Message::Q_ENUM

(

Type

)

stateChanged

void QtPdCom::Message::stateChanged ( )

signal

Friends And Related Function Documentation

MessageModel

friend class MessageModel

friend

Member Data Documentation

Impl

class Q_DECL_HIDDEN QtPdCom::Message::Impl

private

impl

std::unique_ptr<Impl> QtPdCom::Message::impl

private

Referenced by QtPdCom::MessageModel::Impl::addHistoricMessage(), QtPdCom::MessageModel::Impl::addProcessMessage(), QtPdCom::MessageModel::connect(), getDescription(), getIndex(), getPath(), getText(), getTime(), getTimeString(), getType(), isActive(), QtPdCom::MessageModel::load(), and QtPdCom::MessageModel::Impl::stateChanged().

---

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

• QtPdCom1/Message.h
• src/Message.cpp