Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                           qgsexception.h
       3                 :            :                              -------------------
       4                 :            :   begin                : August 31, 2004
       5                 :            :   copyright            : (C) 2004 by Mark Coletti
       6                 :            :   email                : mcoletti at gmail.com
       7                 :            : ***************************************************************************/
       8                 :            : 
       9                 :            : /***************************************************************************
      10                 :            :  *                                                                         *
      11                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      12                 :            :  *   it under the terms of the GNU General Public License as published by  *
      13                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      14                 :            :  *   (at your option) any later version.                                   *
      15                 :            :  *                                                                         *
      16                 :            :  ***************************************************************************/
      17                 :            : #ifndef QGSEXCEPTION_H
      18                 :            : #define QGSEXCEPTION_H
      19                 :            : 
      20                 :            : #define SIP_NO_CREATION
      21                 :            : 
      22                 :            : #define SIP_NO_FILE
      23                 :            : 
      24                 :            : #include <QString>
      25                 :            : 
      26                 :            : #include "qgis_core.h"
      27                 :            : 
      28                 :            : 
      29                 :            : 
      30                 :            : /**
      31                 :            :  * \ingroup core
      32                 :            :  * \brief Defines a QGIS exception class.
      33                 :            :  */
      34                 :          0 : class CORE_EXPORT QgsException
      35                 :            : {
      36                 :            :   public:
      37                 :            : 
      38                 :            :     /**
      39                 :            :      * Constructor for QgsException, with the specified error \a message.
      40                 :            :      */
      41                 :          6 :     QgsException( const QString &message )
      42                 :          6 :       : mWhat( message )
      43                 :         12 :     {}
      44                 :            : 
      45                 :          6 :     virtual ~QgsException() throw() = default;
      46                 :            : 
      47                 :            :     //! \note not available in Python bindings
      48                 :          0 :     QString what() const throw()
      49                 :            :     {
      50                 :          0 :       return mWhat;
      51                 :            :     }
      52                 :            : 
      53                 :            :   private:
      54                 :            : 
      55                 :            :     //! Description of exception
      56                 :            :     QString mWhat;
      57                 :            : 
      58                 :            : };
      59                 :            : 
      60                 :            : 
      61                 :            : /**
      62                 :            :  * \ingroup core
      63                 :            :  * \brief Custom exception class for Coordinate Reference System related exceptions.
      64                 :            :  */
      65                 :          0 : class CORE_EXPORT QgsCsException : public QgsException
      66                 :            : {
      67                 :            :   public:
      68                 :            : 
      69                 :            :     /**
      70                 :            :      * Constructor for QgsCsException, with the specified error \a message.
      71                 :            :      */
      72                 :          0 :     QgsCsException( const QString &message ) : QgsException( message ) {}
      73                 :            : 
      74                 :            : };
      75                 :            : 
      76                 :            : /**
      77                 :            :  * \class QgsProcessingException
      78                 :            :  * \ingroup core
      79                 :            :  * \brief Custom exception class for processing related exceptions.
      80                 :            :  * \since QGIS 3.0
      81                 :            :  */
      82                 :          0 : class CORE_EXPORT QgsProcessingException : public QgsException
      83                 :            : {
      84                 :            :   public:
      85                 :            : 
      86                 :            :     /**
      87                 :            :      * Constructor for QgsProcessingException, with the specified error \a message.
      88                 :            :      */
      89                 :          0 :     QgsProcessingException( const QString &message ) : QgsException( message ) {}
      90                 :            : 
      91                 :            : };
      92                 :            : 
      93                 :            : 
      94                 :            : /**
      95                 :            :  * \class QgsProviderConnectionException
      96                 :            :  * \ingroup core
      97                 :            :  * \brief Custom exception class for provider connection related exceptions.
      98                 :            :  * \since QGIS 3.10
      99                 :            :  */
     100                 :          0 : class CORE_EXPORT QgsProviderConnectionException: public QgsException
     101                 :            : {
     102                 :            :   public:
     103                 :            : 
     104                 :            :     /**
     105                 :            :      * Constructor for QgsProviderConnectionException, with the specified error \a message.
     106                 :            :      */
     107                 :          0 :     QgsProviderConnectionException( const QString &message ) : QgsException( message ) {}
     108                 :            : 
     109                 :            : };
     110                 :            : 
     111                 :            : 
     112                 :            : #endif