QGIS API Documentation  3.4.15-Madeira (e83d02e274)
Public Member Functions | List of all members
QgsWms::QgsServiceException Class Reference

Exception class for WMS service exceptions. More...

#include <qgswmsserviceexception.h>

Inheritance diagram for QgsWms::QgsServiceException:
Inheritance graph
[legend]

Public Member Functions

 QgsServiceException (const QString &code, const QString &message, const QString &locator=QString(), int responseCode=200)
 Constructor for QgsServiceException. More...
 
 QgsServiceException (const QString &code, const QString &message, int responseCode)
 Constructor for QgsServiceException (empty locator attribute). More...
 
- Public Member Functions inherited from QgsOgcServiceException
 QgsOgcServiceException (const QString &code, const QString &message, const QString &locator=QString(), int responseCode=200, const QString &version=QStringLiteral("1.3.0"))
 Construction. More...
 
QString code () const
 Returns the exception code. More...
 
QByteArray formatResponse (QString &responseFormat) const override
 Format the exception for sending to client. More...
 
QString locator () const
 Returns the locator. More...
 
QString message () const
 Returns the exception message. More...
 
QString version () const
 Returns the exception version. More...
 
- Public Member Functions inherited from QgsServerException
 QgsServerException (const QString &message, int responseCode=500)
 Constructor. More...
 
int responseCode () const
 
- Public Member Functions inherited from QgsException
 QgsException (const QString &message)
 Constructor for QgsException, with the specified error message. More...
 
virtual ~QgsException ()=default throw ()
 
QString what () const throw ()
 

Detailed Description

Exception class for WMS service exceptions.

The most important codes are:

Since
QGIS 3.0

Definition at line 41 of file qgswmsserviceexception.h.

Constructor & Destructor Documentation

QgsWms::QgsServiceException::QgsServiceException ( const QString &  code,
const QString &  message,
const QString &  locator = QString(),
int  responseCode = 200 
)
inline

Constructor for QgsServiceException.

Parameters
codeError code name
messageException message to return to the client
locatorLocator attribute according to OGC specifications
responseCodeHTTP error code

Definition at line 52 of file qgswmsserviceexception.h.

QgsWms::QgsServiceException::QgsServiceException ( const QString &  code,
const QString &  message,
int  responseCode 
)
inline

Constructor for QgsServiceException (empty locator attribute).

Parameters
codeError code name
messageException message to return to the client
responseCodeHTTP error code

Definition at line 63 of file qgswmsserviceexception.h.


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