aircraftparts.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2014 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_MISC_AVIATION_AIRCRAFTPARTS_H
#define SWIFT_MISC_AVIATION_AIRCRAFTPARTS_H
 
#include <QMetaType>
#include <QString>
 
#include "misc/aviation/aircraftenginelist.h"
#include "misc/aviation/aircraftlights.h"
#include "misc/metaclass.h"
#include "misc/propertyindexref.h"
#include "misc/swiftmiscexport.h"
#include "misc/timestampbased.h"
#include "misc/valueobject.h"
 
SWIFT_DECLARE_VALUEOBJECT_MIXINS(swift::misc::aviation, CAircraftParts)
 
namespace swift::misc::aviation
{
    class SWIFT_MISC_EXPORT CAircraftParts : public CValueObject<CAircraftParts>, public ITimestampWithOffsetBased
    {
    public:
        enum ColumnIndex
        {
            IndexLights = CPropertyIndexRef::GlobalIndexCAircraftParts,
            IndexGearDown,
            IndexFlapsPercentage,
            IndexSpoilersOut,
            IndexEngines,
            IndexEnginesAsString,
            IndexIsOnGround
        };
 
        enum PartsDetails
        {
            NotSet,
            FSDAircraftParts,
            GuessedParts
        };
 
        CAircraftParts() {}
 
        CAircraftParts(int flapsPercent);
 
        CAircraftParts(const CAircraftLights &lights, bool gearDown, int flapsPercent, bool spoilersOut,
                       const CAircraftEngineList &engines, bool onGround);
 
        CAircraftParts(const CAircraftLights &lights, bool gearDown, int flapsPercent, bool spoilersOut,
                       const CAircraftEngineList &engines, bool onGround, qint64 timestamp);
 
        QVariant propertyByIndex(CPropertyIndexRef index) const;
 
        void setPropertyByIndex(CPropertyIndexRef index, const QVariant &variant);
 
        int comparePropertyByIndex(CPropertyIndexRef index, const CAircraftParts &compareValue) const;
 
        CAircraftLights getLights() const { return m_lights; }
 
        CAircraftLights getAdjustedLights() const;
 
        CAircraftLights &lights() { return m_lights; }
 
        void setLights(const CAircraftLights &lights) { m_lights = lights; }
 
        void setAllLightsOn();
 
        void setAllLightsOff();
 
        bool isGearDown() const { return m_gearDown; }
 
        bool isFixedGearDown() const;
 
        void setGearDown(bool down) { m_gearDown = down; }
 
        int getFlapsPercent() const { return m_flapsPercentage; }
 
        void setFlapsPercent(int flapsPercent) { m_flapsPercentage = flapsPercent; }
 
        bool isSpoilersOut() const { return m_spoilersOut; }
 
        void setSpoilersOut(bool out) { m_spoilersOut = out; }
 
        CAircraftEngineList getEngines() const { return m_engines; }
 
        CAircraftEngineList &engines() { return m_engines; }
 
        CAircraftEngine getEngine(int number) const;
 
        int getEnginesCount() const { return m_engines.size(); }
 
        bool isEngineOn(int number) const;
 
        bool isAnyEngineOn() const;
 
        void setEngines(const CAircraftEngineList &engines) { m_engines = engines; }
 
        void setEngines(const CAircraftEngine &engine, int engineNumber);
 
        bool isOnGround() const { return m_isOnGround; }
 
        void setOnGround(bool onGround) { m_isOnGround = onGround; }
 
        PartsDetails getPartsDetails() const { return static_cast<PartsDetails>(m_partsDetails); }
 
        const QString &getPartsDetailsAsString() const { return partsDetailsToString(this->getPartsDetails()); }
 
        void setPartsDetails(PartsDetails details) { m_partsDetails = static_cast<int>(details); }
 
        QString convertToQString(bool i18n = false) const;
 
        QJsonObject toIncrementalJson() const;
 
        QJsonObject toFullJson() const;
 
        bool isNull() const;
 
        bool equalValues(const CAircraftParts &other) const;
 
        static const CAircraftParts &null();
 
        static const QString &partsDetailsToString(PartsDetails details);
 
        static const QString &attributeNameIsFullJson();
 
        static constexpr int attributesCountFullJson = 7;
 
    private:
        CAircraftLights m_lights;
        CAircraftEngineList m_engines;
        int m_partsDetails = static_cast<int>(NotSet);
        int m_flapsPercentage = 0;
        bool m_gearDown = false;
        bool m_spoilersOut = false;
        bool m_isOnGround = false;
        QString m_guessingDetails; 
 
        SWIFT_METACLASS(
            CAircraftParts,
            SWIFT_METAMEMBER_NAMED(lights, "lights"),
            SWIFT_METAMEMBER_NAMED(gearDown, "gear_down"),
            SWIFT_METAMEMBER_NAMED(flapsPercentage, "flaps_pct"),
            SWIFT_METAMEMBER_NAMED(spoilersOut, "spoilers_out"),
            SWIFT_METAMEMBER_NAMED(engines, "engines"),
            SWIFT_METAMEMBER_NAMED(isOnGround, "on_ground"),
            SWIFT_METAMEMBER(partsDetails, 0, DisabledForJson | DisabledForComparison),
            SWIFT_METAMEMBER(timestampMSecsSinceEpoch, 0, DisabledForJson | DisabledForComparison),
            SWIFT_METAMEMBER(timeOffsetMs, 0, DisabledForJson | DisabledForComparison));
    };
} // namespace swift::misc::aviation
 
Q_DECLARE_METATYPE(swift::misc::aviation::CAircraftParts)
 
#endif // SWIFT_MISC_AVIATION_AIRCRAFTPARTS_H