Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :                           qgsgpsconnectionregistry.h  -  description
       3                 :            :                           --------------------------
       4                 :            :     begin                : December 27th, 2009
       5                 :            :     copyright            : (C) 2009 by Marco Hugentobler
       6                 :            :     email                : marco at hugis dot net
       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                 :            : 
      18                 :            : #ifndef QGSGPSCONNECTIONREGISTRY_H
      19                 :            : #define QGSGPSCONNECTIONREGISTRY_H
      20                 :            : 
      21                 :            : #include <QList>
      22                 :            : #include <QSet>
      23                 :            : 
      24                 :            : #include "qgis_core.h"
      25                 :            : 
      26                 :            : class QgsGpsConnection;
      27                 :            : 
      28                 :            : /**
      29                 :            :  * \ingroup core
      30                 :            :  * \brief A class to register / unregister existing GPS connections such that the information
      31                 :            :  * is available to all classes and plugins.
      32                 :            :  *
      33                 :            :  * QgsGpsConnectionRegistry is not usually directly created, but rather accessed through
      34                 :            :  * QgsApplication::gpsConnectionRegistry().
      35                 :            : */
      36                 :            : class CORE_EXPORT QgsGpsConnectionRegistry
      37                 :            : {
      38                 :            :   public:
      39                 :            : 
      40                 :            :     /**
      41                 :            :      * Constructor for QgsGpsConnectionRegistry.
      42                 :            :      */
      43                 :          5 :     QgsGpsConnectionRegistry() = default;
      44                 :            :     ~QgsGpsConnectionRegistry();
      45                 :            : 
      46                 :            :     //! QgsGpsConnectionRegistry cannot be copied.
      47                 :            :     QgsGpsConnectionRegistry( const QgsGpsConnectionRegistry &rh ) = delete;
      48                 :            :     //! QgsGpsConnectionRegistry cannot be copied.
      49                 :            :     QgsGpsConnectionRegistry &operator=( const QgsGpsConnectionRegistry &rh ) = delete;
      50                 :            : 
      51                 :            :     //! Inserts a connection into the registry. The connection is owned by the registry class until it is unregistered again
      52                 :            :     void registerConnection( QgsGpsConnection *c );
      53                 :            :     //! Unregisters connection. The registry does no longer own the connection
      54                 :            :     void unregisterConnection( QgsGpsConnection *c );
      55                 :            : 
      56                 :            :     QList< QgsGpsConnection *> connectionList() const;
      57                 :            : 
      58                 :            :   private:
      59                 :            : #ifdef SIP_RUN
      60                 :            :     QgsGpsConnectionRegistry( const QgsGpsConnectionRegistry &rh );
      61                 :            : #endif
      62                 :            : 
      63                 :            :     QSet<QgsGpsConnection *> mConnections;
      64                 :            : };
      65                 :            : 
      66                 :            : #endif // QGSGPSCONNECTIONREGISTRY_H