aircraftsituationchange.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2018 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_MISC_AVIATION_AIRCRAFTSITUATIONCHANGE_H
#define SWIFT_MISC_AVIATION_AIRCRAFTSITUATIONCHANGE_H
 
#include "misc/aviation/altitude.h"
#include "misc/aviation/callsign.h"
#include "misc/metaclass.h"
#include "misc/pq/angle.h"
#include "misc/pq/speed.h"
#include "misc/propertyindexref.h"
#include "misc/swiftmiscexport.h"
#include "misc/timestampbased.h"
#include "misc/valueobject.h"
 
SWIFT_DECLARE_VALUEOBJECT_MIXINS(swift::misc::aviation, CAircraftSituationChange)
 
namespace swift::misc
{
    namespace simulation
    {
        class CAircraftModel;
    }
    namespace aviation
    {
        class CAircraftSituation;
        class CAircraftSituationList;
 
        class SWIFT_MISC_EXPORT CAircraftSituationChange :
            public CValueObject<CAircraftSituationChange>,
            public ITimestampWithOffsetBased
        {
        public:
            enum ColumnIndex
            {
                IndexCallsign = CPropertyIndexRef::GlobalIndexCAircraftSituationChange,
                IndexIsNull,
                IndexSituationsCount,
                IndexConstAscending,
                IndexConstDescending,
                IndexConstOnGround,
                IndexConstNotOnGround,
                IndexJustTakingOff,
                IndexJustTouchingDown,
                IndexRotatingUp,
                IndexContainsPushBack,
                IndexAltitudeMean,
                IndexAltitudeStdDev,
                IndexElevationMean,
                IndexElevationStdDev,
            };
 
            enum GuessedSceneryDeviation
            {
                NoDeviationInfo,
                AllOnGround, 
                WasOnGround, 
                SmallAGLDeviationNearGround 
            };
 
            CAircraftSituationChange() = default;
 
            CAircraftSituationChange(const CAircraftSituationList &situations, const physical_quantities::CLength &cg,
                                     bool isVtol, bool alreadySortedLatestFirst = false,
                                     bool calcStdDeviations = false);
 
            const CCallsign &getCallsign() const { return m_correspondingCallsign; }
 
            bool isNull() const { return m_situationsCount < 2; } // we need at least 2 situations
 
            int getSituationsCount() const { return m_situationsCount; }
 
            bool isConstAscending() const { return m_constAscending; }
 
            bool isConstDescending() const { return m_constDescending; }
 
            bool isConstOnGround() const { return m_constOnGround; }
 
            bool wasConstOnGround() const { return m_wasOnGround; }
 
            bool isConstNotOnGround() const { return m_constNotOnGround; }
 
            bool wasConstNotOnGround() const { return m_wasNotOnGround; }
 
            bool isConstAccelerating() const { return m_constAccelerating; }
 
            bool isConstDecelarating() const { return m_constAccelerating; }
 
            bool isJustTakingOff() const { return m_justTakeoff; }
 
            bool isJustTouchingDown() const { return m_justTouchdown; }
 
            bool isRotatingUp() const { return m_rotateUp; }
 
            bool containsPushBack() const { return m_containsPushBack; }
 
            CAltitudePair getElevationStdDevAndMean() const { return CAltitudePair(m_elvStdDev, m_elvMean); }
 
            bool guessOnGround(CAircraftSituation &situation, const simulation::CAircraftModel &model) const;
 
            const physical_quantities::CLength &getGuessedSceneryDeviation() const { return m_guessedSceneryDeviation; }
 
            physical_quantities::CLength getGuessedSceneryDeviationCG() const { return m_guessedSceneryDeviationCG; }
 
            GuessedSceneryDeviation getSceneryDeviationHint() const
            {
                return static_cast<GuessedSceneryDeviation>(m_guessedSceneryDeviationHint);
            }
 
            const QString &getSceneryDeviationHintAsString() const
            {
                return guessedSceneryDeviationToString(this->getSceneryDeviationHint());
            }
 
            bool hasSceneryDeviation() const;
 
            bool hasElevationDevWithinAllowedRange() const;
 
            bool hasAltitudeDevWithinAllowedRange() const;
 
            QString convertToQString(bool i18n = false) const;
 
            QVariant propertyByIndex(CPropertyIndexRef index) const;
 
            void setPropertyByIndex(CPropertyIndexRef index, const QVariant &variant);
 
            int comparePropertyByIndex(CPropertyIndexRef index, const CAircraftSituationChange &compareValue) const;
 
            bool calculateStdDeviations(const CAircraftSituationList &situations,
                                        const physical_quantities::CLength &cg);
 
            static const CAircraftSituationChange &null();
 
            static const QString &guessedSceneryDeviationToString(GuessedSceneryDeviation hint);
 
            static void registerMetadata();
 
        private:
            void setSceneryDeviationHint(GuessedSceneryDeviation hint)
            {
                m_guessedSceneryDeviationHint = static_cast<int>(hint);
            }
 
            void setSceneryDeviation(const physical_quantities::CLength &deviation,
                                     const physical_quantities::CLength &cg, GuessedSceneryDeviation hint);
 
            void guessSceneryDeviation(const physical_quantities::CLength &cg);
 
            int m_situationsCount = -1;
            CCallsign m_correspondingCallsign;
            // latest -> m_timestampMSecsSinceEpoch
            qint64 m_oldestTimestampMSecsSinceEpoch = -1;
            qint64 m_oldestAdjustedTimestampMSecsSinceEpoch = -1;
            qint64 m_latestAdjustedTimestampMSecsSinceEpoch = -1;
            bool m_constAscending = false;
            bool m_constDescending = false;
            bool m_constOnGround = false;
            bool m_wasOnGround = false;
            bool m_constNotOnGround = false;
            bool m_wasNotOnGround = false;
            bool m_justTakeoff = false;
            bool m_justTouchdown = false;
            bool m_rotateUp = false;
            bool m_constAccelerating = false;
            bool m_constDecelerating = false;
            bool m_containsPushBack = false;
            int m_guessedSceneryDeviationHint = static_cast<int>(NoDeviationInfo);
            CAltitude m_altStdDev = CAltitude::null();
            CAltitude m_altMean = CAltitude::null();
            CAltitude m_elvStdDev = CAltitude::null();
            CAltitude m_elvMean = CAltitude::null();
            physical_quantities::CSpeed m_gsStdDev = physical_quantities::CSpeed::null();
            physical_quantities::CSpeed m_gsMean = physical_quantities::CSpeed::null();
            physical_quantities::CAngle m_pitchStdDev = physical_quantities::CAngle::null();
            physical_quantities::CAngle m_pitchMean = physical_quantities::CAngle::null();
            physical_quantities::CLength m_gndDistStdDev = physical_quantities::CLength::null();
            physical_quantities::CLength m_gndDistMean = physical_quantities::CLength::null();
            physical_quantities::CLength m_guessedSceneryDeviation = physical_quantities::CLength::null();
            physical_quantities::CLength m_guessedSceneryDeviationCG = physical_quantities::CLength::null();
            physical_quantities::CLength m_maxGroundDistance = physical_quantities::CLength::null();
            physical_quantities::CLength m_minGroundDistance = physical_quantities::CLength::null();
 
            SWIFT_METACLASS(
                CAircraftSituationChange,
                SWIFT_METAMEMBER(situationsCount),
                SWIFT_METAMEMBER(correspondingCallsign),
                SWIFT_METAMEMBER(constAscending),
                SWIFT_METAMEMBER(constDescending),
                SWIFT_METAMEMBER(constOnGround),
                SWIFT_METAMEMBER(constNotOnGround),
                SWIFT_METAMEMBER(justTakeoff),
                SWIFT_METAMEMBER(justTouchdown),
                SWIFT_METAMEMBER(containsPushBack),
                SWIFT_METAMEMBER(rotateUp),
                SWIFT_METAMEMBER(altStdDev),
                SWIFT_METAMEMBER(altMean),
                SWIFT_METAMEMBER(elvStdDev),
                SWIFT_METAMEMBER(elvMean),
                SWIFT_METAMEMBER(gsStdDev),
                SWIFT_METAMEMBER(gsMean),
                SWIFT_METAMEMBER(gndDistStdDev),
                SWIFT_METAMEMBER(gndDistMean),
                SWIFT_METAMEMBER(pitchStdDev),
                SWIFT_METAMEMBER(pitchMean),
                SWIFT_METAMEMBER(guessedSceneryDeviation),
                SWIFT_METAMEMBER(guessedSceneryDeviationCG),
                SWIFT_METAMEMBER(guessedSceneryDeviationHint),
                SWIFT_METAMEMBER(timestampMSecsSinceEpoch),
                SWIFT_METAMEMBER(oldestTimestampMSecsSinceEpoch),
                SWIFT_METAMEMBER(oldestAdjustedTimestampMSecsSinceEpoch),
                SWIFT_METAMEMBER(latestAdjustedTimestampMSecsSinceEpoch));
        };
    } // namespace aviation
} // namespace swift::misc
 
Q_DECLARE_METATYPE(swift::misc::aviation::CAircraftSituationChange)
Q_DECLARE_METATYPE(swift::misc::aviation::CAircraftSituationChange::GuessedSceneryDeviation)
 
#endif // SWIFT_MISC_AVIATION_AIRCRAFTSITUATIONCHANGE_H