TrafficDataSource_Ogn.h

/***************************************************************************
 *   Copyright (C) 2021-2025 by Stefan Kebekus                             *
 *   stefan.kebekus@gmail.com                                              *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 3 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
 
#pragma once
 
#include <QPointer>
#include <QTcpSocket>
 
#include "traffic/TrafficDataSource_AbstractSocket.h"
#include "traffic/TrafficDataSource_OgnParser.h"
 
using namespace Qt::Literals::StringLiterals;
 
namespace Traffic {

 
class TrafficDataSource_Ogn : public TrafficDataSource_AbstractSocket {
    Q_OBJECT
 
public:
    TrafficDataSource_Ogn(bool isCanonical, QString hostName, quint16 port, QObject *parent = nullptr);
 
    // Standard destructor
    ~TrafficDataSource_Ogn() override;
 
    //
    // Properties
    //

    Q_PROPERTY(QString host READ host CONSTANT)
 
    
    Q_PROPERTY(quint16 port READ port CONSTANT)
 
    //
    // Getter Methods
    //

    [[nodiscard]] Traffic::ConnectionInfo connectionInfo() const override {
        return Traffic::ConnectionInfo(Traffic::ConnectionInfo::OgnInfo());
    }

    [[nodiscard]] QString dataFormat() const override { return u"APRS-IS"_s; }

    [[nodiscard]] QString host() const
    {
        return m_hostName;
    }

    [[nodiscard]] QString icon() const override { return u"/icons/material/ic_wifi.svg"_s; }

    [[nodiscard]] auto sourceName() const -> QString override
    {
        return tr("OGN glidernet.org APRS-IS connection");
    }

    [[nodiscard]] quint16 port() const
    {
        return m_port;
    }
 
public slots:
    void connectToTrafficReceiver() override;

    void disconnectFromTrafficReceiver() override;

    void sendPosition(const QGeoCoordinate& coordinate, double course, double speed, double altitude);
 
private slots:
 
    // Read lines from the socket's text stream and passes the string on to
    // processAprsisMessage.
    void onReadyRead();
 
private:
    Q_DISABLE_COPY_MOVE(TrafficDataSource_Ogn)
 
    QTcpSocket m_socket;
    QTextStream m_textStream;
    QString m_hostName;
    quint16 m_port;
 
    Traffic::Ogn::OgnMessage m_ognMessage;
 
    // our own CallSign
    QString m_callSign;
 
    // our own AircraftType
    Traffic::AircraftType m_aircraftType = {Traffic::AircraftType::Aircraft};
 
    // Radius around the approximate position for which traffic data is requested.
    static constexpr Units::Distance m_receiveRadius = Units::Distance::fromKM(50);
 
    // Periodic update function called once per minute
    void periodicUpdate();
 
    // Send a keep-alive message to the APRS-IS server
    void sendKeepAlive();
 
    // Verify the connection to the APRS-IS server and reconnect if necessary
    void verifyConnection();
};
 
} // namespace Traffic