TrafficFactor_WithPosition.h

/***************************************************************************
 *   Copyright (C) 2021-2026 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 "positioning/PositionInfo.h"
#include "traffic/TrafficFactor_Abstract.h"
#include "traffic/TrafficFactorData.h"
 
 
namespace Traffic {
 

 
class TrafficFactor_WithPosition : public TrafficFactor_Abstract {
    Q_OBJECT
    QML_ELEMENT
 
public:
    explicit TrafficFactor_WithPosition(QObject *parent = nullptr);
 
    // Standard destructor
    ~TrafficFactor_WithPosition() override;
 
    //
    // Methods
    //

    [[nodiscard]] bool updateFrom(const TrafficFactorData_WithPosition& data)
    {
        // Decline records that belong to a different factor.
        if (!isSameFactorAs(data.data))
        {
            return false;
        }
 
        // Same factor: adopt the record if it is newer than what we already
        // hold. An expired slot holds nothing worth keeping, so it takes the
        // record regardless of its timestamp: records are stamped with the
        // system clock at receipt, and a clock step backwards would otherwise
        // keep the slot frozen until the clock has caught up.
        if (!valid() || (positionInfo().timestamp() < data.positionInfo.timestamp()))
        {
            const QScopedPropertyUpdateGroup updateGroup;
            setPositionInfo(data.positionInfo);
            TrafficFactor_Abstract::updateFrom(data.data);
        }
        return true;
    }

    void replaceBy(const TrafficFactorData_WithPosition& data)
    {
        const QScopedPropertyUpdateGroup updateGroup;
        // Order matters here. The deferred change notifications fire in the order
        // the properties are written, and the GUI gates its position/heading
        // animations on "animate". Update the scalar fields first, because
        // TrafficFactor_Abstract::replaceBy() sets animate=false: that disables
        // the animation gate before the positionInfo change (which alone drives
        // the extrapolated coordinate) is processed. Writing positionInfo first
        // would let QML animate the coordinate jump while "animate" is still
        // stale (true), gliding the icon across the map instead of snapping.
        TrafficFactor_Abstract::replaceBy(data.data);
        setPositionInfo(data.positionInfo);
    }
 
 
    //
    // PROPERTIES
    //

    Q_PROPERTY(QGeoCoordinate extrapolatedCoordinate READ extrapolatedCoordinate BINDABLE bindableExtrapolatedCoordinate)
 
    
    [[nodiscard]] QGeoCoordinate extrapolatedCoordinate() const {return m_extrapolatedCoordinate.value();}

    [[nodiscard]] QBindable<QGeoCoordinate> bindableExtrapolatedCoordinate() const {return &m_extrapolatedCoordinate;}

    Q_PROPERTY(Units::Angle extrapolatedTrueTrack READ extrapolatedTrueTrack BINDABLE bindableExtrapolatedTrueTrack)
 
    
    [[nodiscard]] Units::Angle extrapolatedTrueTrack() const {return m_extrapolatedTrueTrack.value();}

    [[nodiscard]] QBindable<Units::Angle> bindableExtrapolatedTrueTrack() const {return &m_extrapolatedTrueTrack;}

    Q_PROPERTY(QString icon READ icon BINDABLE bindableIcon)
 
    
    [[nodiscard]] QString icon() const {return m_icon.value();}

    [[nodiscard]] QBindable<QString> bindableIcon() const {return &m_icon;}

    Q_PROPERTY(Positioning::PositionInfo positionInfo READ positionInfo WRITE setPositionInfo NOTIFY positionInfoChanged BINDABLE bindablePositionInfo)
 
    
    [[nodiscard]] Positioning::PositionInfo positionInfo() const {return m_positionInfo.value();}

    [[nodiscard]] QBindable<Positioning::PositionInfo> bindablePositionInfo() const {return &m_positionInfo;}

    void setPositionInfo(const Positioning::PositionInfo& newPositionInfo) {m_positionInfo = newPositionInfo;}

    Q_PROPERTY(Units::Distance uncertaintyRadius READ uncertaintyRadius BINDABLE bindableUncertaintyRadius)
 
    
    [[nodiscard]] Units::Distance uncertaintyRadius() const {return m_uncertaintyRadius.value();}

    [[nodiscard]] QBindable<Units::Distance> bindableUncertaintyRadius() const {return &m_uncertaintyRadius;}
 
signals:
    void positionInfoChanged();
 
public slots:
    void updateExtrapolatedData();
 
private:
    Q_DISABLE_COPY_MOVE(TrafficFactor_WithPosition)
 
    //
    // Property values
    //
    QProperty<QGeoCoordinate> m_extrapolatedCoordinate;
    QProperty<Units::Angle> m_extrapolatedTrueTrack;
    QProperty<Units::Distance> m_uncertaintyRadius;
    QProperty<QString> m_icon;
    Q_OBJECT_BINDABLE_PROPERTY(Traffic::TrafficFactor_WithPosition, Positioning::PositionInfo, m_positionInfo, &Traffic::TrafficFactor_WithPosition::positionInfoChanged);
};
 
} // namespace Traffic