QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | List of all members
QgsError Class Reference

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

#include <qgserror.h>

Public Member Functions

 QgsError ()
 QgsError (const QString &theMessage, const QString &theTag)
 Constructor with single message.
void append (const QString &theMessage, const QString &theTag)
 Append new error message.
void append (const QgsErrorMessage &theMessage)
 Append new error message.
bool isEmpty () const
 Test if any error is set.
QString message (QgsErrorMessage::Format theFormat=QgsErrorMessage::Html) const
 Full error messages description.
QString summary () const
 Short error descriprion, usually the first error in chain, the real error.
void clear ()
 Clear error messages.

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.

Constructor & Destructor Documentation

QgsError::QgsError ( )
inline
QgsError::QgsError ( const QString &  theMessage,
const QString &  theTag 
)

Constructor with single message.

Parameters
theMessageerror message
theTagshort description, e.g. GDAL, Provider, Layer

Member Function Documentation

void QgsError::append ( const QString &  theMessage,
const QString &  theTag 
)

Append new error message.

Parameters
theMessageerror message string
theTagerror label, for example GDAL, GDAL Provider, Raster layer
void QgsError::append ( const QgsErrorMessage theMessage)

Append new error message.

Parameters
theMessageerror message
void QgsError::clear ( )
inline

Clear error messages.

bool QgsError::isEmpty ( ) const
inline

Test if any error is set.

Returns
true if contains error
QString QgsError::message ( QgsErrorMessage::Format  theFormat = QgsErrorMessage::Html) const

Full error messages description.

Parameters
theFormatoutput format
Returns
error report
QString QgsError::summary ( ) const

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

Returns
error description

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