QgsError Class Reference

QgsError is container for error messages (report). More...

#include <qgserror.h>

Public Member Functions
	QgsError ()=default
	Constructor for QgsError. More...
	QgsError (const QString &message, const QString &tag)
	Constructor with single message. More...
void	append (const QgsErrorMessage &message)
	Append new error message. More...
void	append (const QString &message, const QString &tag)
	Append new error message. More...
void	clear ()
	Clear error messages. More...
bool	isEmpty () const
	Test if any error is set. More...
QString	message (QgsErrorMessage::Format format=QgsErrorMessage::Html) const
	Full error messages description. More...
QList< QgsErrorMessage >	messageList () const
	messageList return the list of current error messages More...
QString	summary () const
	Short error description, usually the first error in chain, the real error. More...

Detailed Description

QgsError is container for error messages (report).

It may contain chain (sort of traceback) of error messages (e.g. GDAL - provider - layer). Higher level messages are appended at the end.

Definition at line 80 of file qgserror.h.

Constructor & Destructor Documentation

QgsError() [1/2]

QgsError::QgsError ( )

default

Constructor for QgsError.

QgsError() [2/2]

QgsError::QgsError	(	const QString &	message,
		const QString &	tag
	)

Constructor with single message.

Parameters

message	error message
tag	short description, e.g. GDAL, Provider, Layer

Definition at line 34 of file qgserror.cpp.

Member Function Documentation

append() [1/2]

void QgsError::append

(

const QgsErrorMessage &

message

)

Append new error message.

Parameters

message

error message

Definition at line 44 of file qgserror.cpp.

append() [2/2]

void QgsError::append	(	const QString &	message,
		const QString &	tag
	)

Append new error message.

Parameters

message	error message string
tag	error label, for example GDAL, GDAL Provider, Raster layer

Definition at line 39 of file qgserror.cpp.

clear()

void QgsError::clear ( )

inline

Clear error messages.

Definition at line 127 of file qgserror.h.

isEmpty()

bool QgsError::isEmpty ( ) const

inline

Test if any error is set.

Returns

true if contains error

Definition at line 111 of file qgserror.h.

message()

QString QgsError::message

(

QgsErrorMessage::Format

format = QgsErrorMessage::Html

)

const

Full error messages description.

Parameters

format

output format

Returns

error report

Definition at line 49 of file qgserror.cpp.

messageList()

QList<QgsErrorMessage> QgsError::messageList ( ) const

inline

messageList return the list of current error messages

Returns

current list of error messages

Definition at line 133 of file qgserror.h.

summary()

QString QgsError::summary

(

)

const

Short error description, usually the first error in chain, the real error.

Returns

error description

Definition at line 129 of file qgserror.cpp.

---

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

• /build/qgis-3.22.4+99unstable/src/core/qgserror.h
• /build/qgis-3.22.4+99unstable/src/core/qgserror.cpp