Avoid hardcoded receiver strings in favor of static class identifiers

opengisch · Dec 20, 2024 · dea087c · dea087c
1 parent 99187e2
commit dea087c
Show file tree

Hide file tree

Showing 11 changed files with 45 additions and 9 deletions.
diff --git a/src/core/positioning/egenioussreceiver.cpp b/src/core/positioning/egenioussreceiver.cpp
@@ -21,6 +21,8 @@
 #include <QJsonValue>
 #include <QTimeZone>
 
+QLatin1String EgenioussReceiver::identifier = QLatin1String( "egeniouss" );
+
 EgenioussReceiver::EgenioussReceiver( QObject *parent )
   : AbstractGnssReceiver( parent ), mTcpSocket( new QTcpSocket() )
 {

diff --git a/src/core/positioning/egenioussreceiver.h b/src/core/positioning/egenioussreceiver.h
@@ -35,6 +35,8 @@ class EgenioussReceiver : public AbstractGnssReceiver
 
     QList<QPair<QString, QVariant>> details() const override;
 
+    static QLatin1String identifier;
+
   private:
     void handleConnectDevice() override;
     void handleDisconnectDevice() override;

diff --git a/src/core/positioning/positioning.cpp b/src/core/positioning/positioning.cpp
@@ -16,6 +16,11 @@
 
 #include "positioning.h"
 #include "positioningutils.h"
+#include "tcpreceiver.h"
+#include "udpreceiver.h"
+#ifdef WITH_SERIALPORT
+#include "serialportreceiver.h"
+#endif
 
 #include <QScreen>
 #include <qgsapplication.h>
@@ -137,11 +142,18 @@ QString Positioning::deviceSocketStateString() const
 AbstractGnssReceiver::Capabilities Positioning::deviceCapabilities() const
 {
   const QString deviceId = mPositioningSourceReplica->property( "deviceId" ).toString();
-  if ( !deviceId.isEmpty() || deviceId.startsWith( QStringLiteral( "tcp:" ) ) || deviceId.startsWith( QStringLiteral( "ucp:" ) ) || deviceId.startsWith( QStringLiteral( "serial:" ) ) )
+  if ( !deviceId.isEmpty() || deviceId.startsWith( TcpReceiver::identifier + ":" ) || deviceId.startsWith( UdpReceiver::identifier + ":" ) )
   {
     // NMEA-based devices
     return AbstractGnssReceiver::Capabilities() | AbstractGnssReceiver::OrthometricAltitude | AbstractGnssReceiver::Logging;
   }
+#ifdef WITH_SERIALPORT
+  else if ( deviceId.startsWith( SerialPortReceiver::identifier + ":" ) )
+  {
+    // NMEA-based device
+    return AbstractGnssReceiver::Capabilities() | AbstractGnssReceiver::OrthometricAltitude | AbstractGnssReceiver::Logging;
+  }
+#endif
 
   return AbstractGnssReceiver::NoCapabilities;
 }

diff --git a/src/core/positioning/positioningdevicemodel.cpp b/src/core/positioning/positioningdevicemodel.cpp
@@ -14,7 +14,13 @@
  *                                                                         *
  ***************************************************************************/
 
+#include "egenioussreceiver.h"
 #include "positioningdevicemodel.h"
+#include "tcpreceiver.h"
+#include "udpreceiver.h"
+#ifdef WITH_SERIALPORT
+#include "serialportreceiver.h"
+#endif
 
 #include <QSettings>
 
@@ -164,16 +170,18 @@ const QString PositioningDeviceModel::deviceId( const Device &device ) const
       return device.settings.value( QStringLiteral( "address" ) ).toString();
 
     case TcpDevice:
-      return QStringLiteral( "tcp:%1:%2" ).arg( device.settings.value( QStringLiteral( "address" ) ).toString(), QString::number( device.settings.value( QStringLiteral( "port" ) ).toInt() ) );
+      return QStringLiteral( "%1:%2:%3" ).arg( TcpReceiver::identifier, device.settings.value( QStringLiteral( "address" ) ).toString(), QString::number( device.settings.value( QStringLiteral( "port" ) ).toInt() ) );
 
     case UdpDevice:
-      return QStringLiteral( "udp:%1:%2" ).arg( device.settings.value( QStringLiteral( "address" ) ).toString(), QString::number( device.settings.value( QStringLiteral( "port" ) ).toInt() ) );
+      return QStringLiteral( "%1:%2:%3" ).arg( UdpReceiver::identifier, device.settings.value( QStringLiteral( "address" ) ).toString(), QString::number( device.settings.value( QStringLiteral( "port" ) ).toInt() ) );
 
+#ifdef WITH_SERIALPORT
     case SerialPortDevice:
-      return QStringLiteral( "serial:%1" ).arg( device.settings.value( QStringLiteral( "address" ) ).toString() );
+      return QStringLiteral( "%1:%2" ).arg( SerialPortReceiver::identifier, device.settings.value( QStringLiteral( "address" ) ).toString() );
+#endif
 
     case EgenioussDevice:
-      return QStringLiteral( "egeniouss:" );
+      return QStringLiteral( "%1:" ).arg( EgenioussReceiver::identifier );
   }
 
   return QString();

diff --git a/src/core/positioning/positioningsource.cpp b/src/core/positioning/positioningsource.cpp
@@ -177,26 +177,26 @@ void PositioningSource::setupDevice()
   }
   else
   {
-    if ( mDeviceId.startsWith( QStringLiteral( "tcp:" ) ) )
+    if ( mDeviceId.startsWith( TcpReceiver::identifier + ":" ) )
     {
       const qsizetype portSeparator = mDeviceId.lastIndexOf( ':' );
       const QString address = mDeviceId.mid( 4, portSeparator - 4 );
       const int port = mDeviceId.mid( portSeparator + 1 ).toInt();
       mReceiver = new TcpReceiver( address, port, this );
     }
-    else if ( mDeviceId.startsWith( QStringLiteral( "udp:" ) ) )
+    else if ( mDeviceId.startsWith( UdpReceiver::identifier + ":" ) )
     {
       const qsizetype portSeparator = mDeviceId.lastIndexOf( ':' );
       const QString address = mDeviceId.mid( 4, portSeparator - 4 );
       const int port = mDeviceId.mid( portSeparator + 1 ).toInt();
       mReceiver = new UdpReceiver( address, port, this );
     }
-    else if ( mDeviceId.startsWith( QStringLiteral( "egeniouss:" ) ) )
+    else if ( mDeviceId.startsWith( EgenioussReceiver::identifier + ":" ) )
     {
       mReceiver = new EgenioussReceiver( this );
     }
 #ifdef WITH_SERIALPORT
-    else if ( mDeviceId.startsWith( QStringLiteral( "serial:" ) ) )
+    else if ( mDeviceId.startsWith( SerialPortReceiver::identifier + ":" ) )
     {
       const QString address = mDeviceId.mid( 7 );
       mReceiver = new SerialPortReceiver( address, this );

diff --git a/src/core/positioning/serialportreceiver.cpp b/src/core/positioning/serialportreceiver.cpp
@@ -16,6 +16,8 @@
 
 #include "serialportreceiver.h"
 
+QLatin1String SerialPortReceiver::identifier = QLatin1String( "serial" );
+
 SerialPortReceiver::SerialPortReceiver( const QString &address, QObject *parent )
   : NmeaGnssReceiver( parent )
   , mAddress( address )

diff --git a/src/core/positioning/serialportreceiver.h b/src/core/positioning/serialportreceiver.h
@@ -34,6 +34,8 @@ class SerialPortReceiver : public NmeaGnssReceiver
     explicit SerialPortReceiver( const QString &address = QString(), QObject *parent = nullptr );
     ~SerialPortReceiver() override;
 
+    static QLatin1String identifier;
+
   private:
     void handleConnectDevice() override;
     void handleDisconnectDevice() override;

diff --git a/src/core/positioning/tcpreceiver.cpp b/src/core/positioning/tcpreceiver.cpp
@@ -16,6 +16,8 @@
 
 #include "tcpreceiver.h"
 
+QLatin1String TcpReceiver::identifier = QLatin1String( "tcp" );
+
 TcpReceiver::TcpReceiver( const QString &address, const int port, QObject *parent )
   : NmeaGnssReceiver( parent )
   , mAddress( address )

diff --git a/src/core/positioning/tcpreceiver.h b/src/core/positioning/tcpreceiver.h
@@ -35,6 +35,8 @@ class TcpReceiver : public NmeaGnssReceiver
     explicit TcpReceiver( const QString &address = QString(), const int port = 0, QObject *parent = nullptr );
     ~TcpReceiver() override;
 
+    static QLatin1String identifier;
+
   public slots:
     QString socketStateString() override;
 

diff --git a/src/core/positioning/udpreceiver.cpp b/src/core/positioning/udpreceiver.cpp
@@ -20,6 +20,8 @@
 #include <sys/socket.h>
 #endif
 
+QLatin1String UdpReceiver::identifier = QLatin1String( "udp" );
+
 UdpReceiver::UdpReceiver( const QString &address, const int port, QObject *parent )
   : NmeaGnssReceiver( parent )
   , mAddress( address )

diff --git a/src/core/positioning/udpreceiver.h b/src/core/positioning/udpreceiver.h
@@ -36,6 +36,8 @@ class UdpReceiver : public NmeaGnssReceiver
     explicit UdpReceiver( const QString &address = QString(), const int port = 0, QObject *parent = nullptr );
     ~UdpReceiver() override;
 
+    static QLatin1String identifier;
+
   public slots:
     QString socketStateString() override;