TrafficDataSource_Simulate.h

/***************************************************************************
 *   Copyright (C) 2021-2024 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 <QGeoPositionInfo>
 
#include <optional>
 
#include "traffic/TrafficDataSource_Abstract.h"
 
using namespace Qt::Literals::StringLiterals;
 
 
namespace Traffic {

class TrafficDataSource_Simulate : public TrafficDataSource_Abstract {
    Q_OBJECT
 
public:
    TrafficDataSource_Simulate(bool isCanonical, QObject* parent);
 
    // Standard destructor
    ~TrafficDataSource_Simulate() override = default;

    [[nodiscard]] QString dataFormat() const override { return u"FLARM/NMEA"_s; }

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

    [[nodiscard]] auto sourceName() const -> QString override
    {
        return tr("Simulator data");
    }
 
public slots:
    void connectToTrafficReceiver() override;

    void disconnectFromTrafficReceiver() override;

    void setBarometricHeight(Units::Distance barAlt)
    {
        barometricHeight = barAlt;
    }

    void setCoordinate(const QGeoCoordinate& coordinate)
    {
        geoInfo.setCoordinate(coordinate);
        geoInfo.setAttribute(QGeoPositionInfo::VerticalSpeed, 0.0);
    }

    void setGS(Units::Speed GS)
    {
        geoInfo.setAttribute(QGeoPositionInfo::GroundSpeed, GS.toMPS());
    }

    void setTT(Units::Angle TT)
    {
        geoInfo.setAttribute(QGeoPositionInfo::Direction, TT.toDEG());
    }

    void setTrafficFactor_DistanceOnly(const Traffic::TrafficFactorData_DistanceOnly& factor)
    {
        trafficFactor_DistanceOnly = factor;
    }

    void clearTrafficFactor_DistanceOnly()
    {
        trafficFactor_DistanceOnly.reset();
    }

    void setVSpeed(Units::Speed vSpeed)
    {
        geoInfo.setAttribute(QGeoPositionInfo::VerticalSpeed, vSpeed.toMPS());
    }

    void addTraffic(const Traffic::TrafficFactorData_WithPosition& factor)
    {
        trafficFactors.append(factor);
    }

    void removeTraffic()
    {
        trafficFactors.clear();
    }
 
private slots:
    // Send out simulated data. This slot will be called once per second once
    // connectToTrafficReceiver() has been called
    void sendSimulatorData();
 
private:
    Q_DISABLE_COPY_MOVE(TrafficDataSource_Simulate)
 
    // Simulator related members
    QTimer simulatorTimer;
    QGeoPositionInfo geoInfo;
    Units::Distance barometricHeight;
    QVector<TrafficFactorData_WithPosition> trafficFactors;
    std::optional<TrafficFactorData_DistanceOnly> trafficFactor_DistanceOnly = std::nullopt;
};
 
} // namespace Traffic