ongroundinfo.h

Go to the documentation of this file.

//  SPDX-FileCopyrightText: Copyright (C) swift Project Community / Contributors
//  SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1

 
#ifndef SWIFT_MISC_AVIATION_ONGROUNDINFO_H
#define SWIFT_MISC_AVIATION_ONGROUNDINFO_H
 
#include "misc/pq/length.h"
#include "misc/swiftmiscexport.h"
#include "misc/valueobject.h"
 
SWIFT_DECLARE_VALUEOBJECT_MIXINS(swift::misc::Aviation, COnGroundInfo)
 
namespace swift::misc::aviation
{
    class SWIFT_MISC_EXPORT COnGroundInfo : public CValueObject<COnGroundInfo>
    {
    public:
        enum IsOnGround
        {
            NotOnGround,
            OnGround,
            OnGroundSituationUnknown
        };

        enum OnGroundDetails
        {
            NotSetGroundDetails, 
            // interpolated situation
            OnGroundByInterpolation, 
            OnGroundByElevationAndCG,
            OnGroundByGuessing, 
            // received situation
            InFromNetwork, 
            InFromParts, 
            // send information
            OutOnGroundOwnAircraft 
        };

        enum ColumnIndex
        {
            IndexOnGroundFactor = CPropertyIndexRef::GlobalIndexCOnGroundInfo,
            IndexOnGroundDetails,
        };
 
        COnGroundInfo() = default;

        COnGroundInfo(IsOnGround onGround, OnGroundDetails details);

        COnGroundInfo(const physical_quantities::CLength &cg, const physical_quantities::CLength &groundDistance);

        explicit COnGroundInfo(double interpolatedGndFactor);

        double getGroundFactor() const { return m_onGroundFactor; }

        void setOnGroundDetails(OnGroundDetails details)
        {
            // TODO Assert not by interpolation
            m_onGroundDetails = static_cast<int>(details);
        }

        IsOnGround getOnGround() const;

        OnGroundDetails getGroundDetails() const;

        QString convertToQString(bool i18n = false) const;

        QVariant propertyByIndex(CPropertyIndexRef index) const;

        void setPropertyByIndex(CPropertyIndexRef index, const QVariant &variant);

        static void registerMetadata();

        static const QString &isOnGroundToString(IsOnGround onGround);

        static const QString &onGroundDetailsToString(OnGroundDetails reliability);

        static const physical_quantities::CLength &deltaNearGround();
 
    private:
        bool isOnGround() const;
 
        int m_onGroundDetails = static_cast<int>(OnGroundDetails::NotSetGroundDetails);
        double m_onGroundFactor = -1.0; 
 
        static constexpr double m_groundFactorThreshold =
            0.95; 
 
        SWIFT_METACLASS(
            COnGroundInfo,
            SWIFT_METAMEMBER(onGroundDetails),
            SWIFT_METAMEMBER(onGroundFactor));
    };
 
} // namespace swift::misc::aviation
 
Q_DECLARE_METATYPE(swift::misc::aviation::COnGroundInfo)
Q_DECLARE_METATYPE(swift::misc::aviation::COnGroundInfo::IsOnGround)
Q_DECLARE_METATYPE(swift::misc::aviation::COnGroundInfo::OnGroundDetails)
 
#endif // SWIFT_MISC_AVIATION_ONGROUNDINFO_H