refs #216, airport ICAO class needed for flightplan

* added class
* adjusted flightplan class, also added some convenience methods to FP class

src/blackmisc/avairporticao.cpp

@@ -0,0 +1,144 @@
+#include "avairporticao.h"
+
+namespace BlackMisc
+{
+    namespace Aviation
+    {
+        /*
+         * Convert to string
+         */
+        QString CAirportIcao::convertToQString(bool /** i18n **/) const
+        {
+            return this->m_icaoCode;
+        }
+
+        /*
+         * Equals callsign?
+         */
+        bool CAirportIcao::equalsString(const QString &icaoCode) const
+        {
+            CAirportIcao other(icaoCode);
+            return other == (*this);
+        }
+
+        /*
+         * Compare
+         */
+        int CAirportIcao::compareImpl(const CValueObject &otherBase) const
+        {
+            // intentionally compare on string only!
+            const auto &other = static_cast<const CAirportIcao &>(otherBase);
+            return this->m_icaoCode.compare(other.m_icaoCode, Qt::CaseInsensitive);
+        }
+
+        /*
+         * Marshall to DBus
+         */
+        void CAirportIcao::marshallToDbus(QDBusArgument &argument) const
+        {
+            argument << TupleConverter<CAirportIcao>::toTuple(*this);
+        }
+
+        /*
+         * Unmarshall from DBus
+         */
+        void CAirportIcao::unmarshallFromDbus(const QDBusArgument &argument)
+        {
+            argument >> TupleConverter<CAirportIcao>::toTuple(*this);
+        }
+
+        /*
+         * To JSON
+         */
+        QJsonObject CAirportIcao::toJson() const
+        {
+            return BlackMisc::serializeJson(CAirportIcao::jsonMembers(), TupleConverter<CAirportIcao>::toTuple(*this));
+        }
+
+        /*
+         * To JSON
+         */
+        void CAirportIcao::fromJson(const QJsonObject &json)
+        {
+            BlackMisc::deserializeJson(json, CAirportIcao::jsonMembers(), TupleConverter<CAirportIcao>::toTuple(*this));
+        }
+
+        /*
+         * Members
+         */
+        const QStringList &CAirportIcao::jsonMembers()
+        {
+            return TupleConverter<CAirportIcao>::jsonMembers();
+        }
+
+        QString CAirportIcao::unifyAirportCode(const QString &icaoCode)
+        {
+            QString code = icaoCode.trimmed().toUpper();
+            if (code.length() != 4) return "";
+            QRegExp reg("[A-Z]{4}");
+            return (reg.exactMatch(code)) ? code : "";
+        }
+
+        /*
+         * Equal?
+         */
+        bool CAirportIcao::operator ==(const CAirportIcao &other) const
+        {
+            if (this == &other) return true;
+            // intentionally not via Tupel converter, compare on string only
+            return this->asString().compare(other.asString(), Qt::CaseInsensitive) == 0;
+        }
+
+        /*
+         * Unequal?
+         */
+        bool CAirportIcao::operator !=(const CAirportIcao &other) const
+        {
+            return !((*this) == other);
+        }
+
+        /*
+         * Hash
+         */
+        uint CAirportIcao::getValueHash() const
+        {
+            return qHash(TupleConverter<CAirportIcao>::toTuple(*this));
+        }
+
+        /*
+         * Less than?
+         */
+        bool CAirportIcao::operator <(const CAirportIcao &other) const
+        {
+            return this->m_icaoCode < other.m_icaoCode;
+        }
+
+        /*
+         * metaTypeId
+         */
+        int CAirportIcao::getMetaTypeId() const
+        {
+            return qMetaTypeId<CAirportIcao>();
+        }
+
+        /*
+         * is a
+         */
+        bool CAirportIcao::isA(int metaTypeId) const
+        {
+            if (metaTypeId == qMetaTypeId<CAirportIcao>()) { return true; }
+
+            return this->CValueObject::isA(metaTypeId);
+        }
+
+        /*
+         * Register metadata
+         */
+        void CAirportIcao::registerMetadata()
+        {
+            qRegisterMetaType<CAirportIcao>();
+            qDBusRegisterMetaType<CAirportIcao>();
+        }
+
+    } // namespace
+} // namespace

src/blackmisc/avairporticao.h

@@ -0,0 +1,102 @@
+/* Copyright (C) 2013 VATSIM Community / authors
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#ifndef BLACKMISC_AIRPORTICAO_H
+#define BLACKMISC_AIRPORTICAO_H
+#include "valueobject.h"
+
+namespace BlackMisc
+{
+    namespace Aviation
+    {
+        //! \brief Value object encapsulating information of a callsign.
+        class CAirportIcao : public BlackMisc::CValueObject
+        {
+
+        public:
+            //! Default constructor.
+            CAirportIcao() {}
+
+            //! Constructor
+            CAirportIcao(const QString &icaoCode) : m_icaoCode(CAirportIcao::unifyAirportCode(icaoCode))
+            {}
+
+            //! Constructor, needed to disambiguate implicit conversion from string literal.
+            CAirportIcao(const char *icaoCode)
+                : m_icaoCode(CAirportIcao::unifyAirportCode(icaoCode))
+            {}
+
+            //! \copydoc CValueObject::toQVariant()
+            virtual QVariant toQVariant() const override { return QVariant::fromValue(*this); }
+
+            //! Is empty?
+            bool isEmpty() const { return this->m_icaoCode.isEmpty(); }
+
+            //! Get code.
+            const QString &asString() const { return this->m_icaoCode; }
+
+            //! Get ICAO code
+            QString getIcaoCode() const { return m_icaoCode; }
+
+            //! Equals callsign string?
+            bool equalsString(const QString &icaoCode) const;
+
+            //! Equal operator ==
+            bool operator ==(const CAirportIcao &other) const;
+
+            //! Unequal operator !=
+            bool operator !=(const CAirportIcao &other) const;
+
+            //! Less than operator < for sorting
+            bool operator <(const CAirportIcao &other) const;
+
+            //! \copydoc CValueObject::getValueHash()
+            virtual uint getValueHash() const override;
+
+            //! \copydoc CValueObject::toJson
+            virtual QJsonObject toJson() const override;
+
+            //! \copydoc CValueObject::fromJson
+            virtual void fromJson(const QJsonObject &json) override;
+
+            //! Register metadata
+            static void registerMetadata();
+
+            //! Members
+            static const QStringList &jsonMembers();
+
+            //! Unify code
+            static QString unifyAirportCode(const QString &icaoCode);
+
+        protected:
+            //! \copydoc CValueObject::convertToQString()
+            virtual QString convertToQString(bool i18n = false) const override;
+
+            //! \copydoc CValueObject::getMetaTypeId
+            virtual int getMetaTypeId() const override;
+
+            //! \copydoc CValueObject::isA
+            virtual bool isA(int metaTypeId) const override;
+
+            //! \copydoc CValueObject::compareImpl
+            virtual int compareImpl(const CValueObject &other) const override;
+
+            //! \copydoc CValueObject::marshallToDbus()
+            virtual void marshallToDbus(QDBusArgument &argument) const override;
+
+            //! \copydoc CValueObject::unmarshallFromDbus()
+            virtual void unmarshallFromDbus(const QDBusArgument &argument) override;
+
+        private:
+            BLACK_ENABLE_TUPLE_CONVERSION(CAirportIcao)
+            QString m_icaoCode;
+        };
+    } // namespace
+} // namespace
+
+BLACK_DECLARE_TUPLE_CONVERSION(BlackMisc::Aviation::CAirportIcao, (o.m_icaoCode))
+Q_DECLARE_METATYPE(BlackMisc::Aviation::CAirportIcao)
+
+#endif // guard

src/blackmisc/avflightplan.cpp

@@ -29,16 +29,16 @@ namespace BlackMisc
         {
             QString s;
             s.append(m_equipmentIcao);
-            s.append(" ").append(m_originAirportIcao);
+            s.append(" ").append(m_originAirportIcao.toQString(i18n));
-            s.append(" ").append(m_destinationAirportIcao);
+            s.append(" ").append(m_destinationAirportIcao.toQString(i18n));
-            s.append(" ").append(m_alternateAirportIcao);
+            s.append(" ").append(m_alternateAirportIcao.toQString(i18n));
             s.append(" ").append(m_takeoffTimePlanned.toString("ddhhmm"));
             s.append(" ").append(m_takeoffTimeActual.toString("ddhhmm"));
             s.append(" ").append(m_enrouteTime.toQString(i18n));
             s.append(" ").append(m_fuelTime.toQString(i18n));
             s.append(" ").append(m_cruiseAltitude.toQString(i18n));
             s.append(" ").append(m_cruiseTrueAirspeed.toQString(i18n));
-            switch(m_flightRules)
+            switch (m_flightRules)
             {
             case VFR:   s.append(" VFR"); break;
             case IFR:   s.append(" IFR"); break;

src/blackmisc/avflightplan.h

@@ -12,6 +12,7 @@
 
 #include "valueobject.h"
 #include "avaltitude.h"
+#include "avairporticao.h"
 #include "pqtime.h"
 #include "pqspeed.h"
 #include <QDateTime>
@@ -44,12 +45,12 @@ namespace BlackMisc
             /*!
              * Constructor
              */
-            CFlightPlan(const QString &equipmentIcao, const QString &originAirportIcao, const QString &destinationAirportIcao, const QString &alternateAirportIcao,
+            CFlightPlan(const QString &equipmentIcao, const CAirportIcao &originAirportIcao, const CAirportIcao &destinationAirportIcao, const CAirportIcao &alternateAirportIcao,
-                QDateTime takeoffTimePlanned, QDateTime takeoffTimeActual, const PhysicalQuantities::CTime &enrouteTime, const PhysicalQuantities::CTime &fuelTime,
+                        QDateTime takeoffTimePlanned, QDateTime takeoffTimeActual, const PhysicalQuantities::CTime &enrouteTime, const PhysicalQuantities::CTime &fuelTime,
-                const CAltitude &cruiseAltitude, const PhysicalQuantities::CSpeed &cruiseTrueAirspeed, FlightRules flightRules, const QString &route, const QString &remarks)
+                        const CAltitude &cruiseAltitude, const PhysicalQuantities::CSpeed &cruiseTrueAirspeed, FlightRules flightRules, const QString &route, const QString &remarks)
-            : m_equipmentIcao(equipmentIcao), m_originAirportIcao(originAirportIcao), m_destinationAirportIcao(destinationAirportIcao), m_alternateAirportIcao(alternateAirportIcao),
+                : m_equipmentIcao(equipmentIcao), m_originAirportIcao(originAirportIcao), m_destinationAirportIcao(destinationAirportIcao), m_alternateAirportIcao(alternateAirportIcao),
-              m_takeoffTimePlanned(takeoffTimePlanned), m_takeoffTimeActual(takeoffTimeActual), m_enrouteTime(enrouteTime), m_fuelTime(fuelTime),
+                  m_takeoffTimePlanned(takeoffTimePlanned), m_takeoffTimeActual(takeoffTimeActual), m_enrouteTime(enrouteTime), m_fuelTime(fuelTime),
-              m_cruiseAltitude(cruiseAltitude), m_cruiseTrueAirspeed(cruiseTrueAirspeed), m_flightRules(flightRules), m_route(route), m_remarks(remarks.left(100))
+                  m_cruiseAltitude(cruiseAltitude), m_cruiseTrueAirspeed(cruiseTrueAirspeed), m_flightRules(flightRules), m_route(route), m_remarks(remarks.left(100))
             {}
 
             //! Set ICAO aircraft equipment code string (e.g. "T/A320/F")
@@ -58,24 +59,42 @@ namespace BlackMisc
             //! Set origin airport ICAO code
             void setOriginAirportIcao(const QString &originAirportIcao) { m_originAirportIcao = originAirportIcao; }
 
+            //! Set origin airport ICAO code
+            void setOriginAirportIcao(const CAirportIcao &originAirportIcao) { m_originAirportIcao = originAirportIcao; }
+
             //! Set destination airport ICAO code
             void setDestinationAirportIcao(const QString &destinationAirportIcao) { m_destinationAirportIcao = destinationAirportIcao; }
 
+            //! Set destination airport ICAO code
+            void setDestinationAirportIcao(const CAirportIcao &destinationAirportIcao) { m_destinationAirportIcao = destinationAirportIcao; }
+
             //! Set alternate destination airport ICAO code
             void setAlternateAirportIcao(const QString &alternateAirportIcao) { m_alternateAirportIcao = alternateAirportIcao; }
 
+            //! Set alternate destination airport ICAO code
+            void setAlternateAirportIcao(const CAirportIcao &alternateAirportIcao) { m_alternateAirportIcao = alternateAirportIcao; }
+
             //! Set planned takeoff time
             void setTakeoffTimePlanned(QDateTime takeoffTimePlanned) { m_takeoffTimePlanned = takeoffTimePlanned; }
 
+            //! Set planned takeoff time hh:mm
+            void setTakeoffTimePlanned(QString time) { m_takeoffTimePlanned = QDateTime::currentDateTimeUtc(); m_takeoffTimePlanned.setTime(QTime::fromString(time, "hh:mm"));}
+
             //! Set actual takeoff time (reserved for ATC use)
             void setTakeoffTimeActual(QDateTime takeoffTimeActual) { m_takeoffTimeActual = takeoffTimeActual; }
 
+            //! Set actual takeoff time hh:mm
+            void setTakeoffTimeActual(QString time) { m_takeoffTimeActual = QDateTime::currentDateTimeUtc(); m_takeoffTimeActual.setTime(QTime::fromString(time, "hh:mm"));}
+
             //! Set planned enroute flight time
             void setEnrouteTime(const PhysicalQuantities::CTime &enrouteTime) { m_enrouteTime = enrouteTime; }
 
             //! Set amount of fuel load in time
             void setFuelTime(const PhysicalQuantities::CTime &fuelTime) { m_fuelTime = fuelTime; }
 
+            //! Set amount of fuel load in time hh:mm
+            void setFuelTime(const QString &fuelTime) { m_fuelTime = PhysicalQuantities::CTime(fuelTime); }
+
             //! Set planned cruise altitude
             void setCruiseAltitude(const CAltitude &cruiseAltitude) { m_cruiseAltitude = cruiseAltitude; }
 
@@ -83,7 +102,7 @@ namespace BlackMisc
             void setCruiseTrueAirspeed(const PhysicalQuantities::CSpeed &cruiseTrueAirspeed) { m_cruiseTrueAirspeed = cruiseTrueAirspeed; }
 
             //! Set flight rules (VFR or IFR)
-            void setFlightRules(FlightRules flightRules) { m_flightRules = flightRules; }
+            void setFlightRule(FlightRules flightRules) { m_flightRules = flightRules; }
 
             //! Set route string
             void setRoute(const QString &route) { m_route = route; }
@@ -95,28 +114,40 @@ namespace BlackMisc
             const QString &getEquipmentIcao() const { return m_equipmentIcao; }
 
             //! Get origin airport ICAO code
-            const QString &getOriginAirportIcao() const { return m_originAirportIcao; }
+            const CAirportIcao &getOriginAirportIcao() const { return m_originAirportIcao; }
 
             //! Get destination airport ICAO code
-            const QString &getDestinationAirportIcao() const { return m_destinationAirportIcao; }
+            const CAirportIcao &getDestinationAirportIcao() const { return m_destinationAirportIcao; }
 
             //! Get alternate destination airport ICAO code
-            const QString &getAlternateAirportIcao() const { return m_alternateAirportIcao; }
+            const CAirportIcao &getAlternateAirportIcao() const { return m_alternateAirportIcao; }
 
-            //! Get planned takeoff time
+            //! Get planned takeoff time (planned)
-            QDateTime getTakeoffTimePlanned() const { return m_takeoffTimePlanned; }
+            const QDateTime &getTakeoffTimePlanned() const { return m_takeoffTimePlanned; }
 
-            //! Get actual takeoff time
+            //! Get planned takeoff time (planned)
-            QDateTime getTakeoffTimeActual() const { return m_takeoffTimeActual; }
+            QString getTakeoffTimePlannedHourMin() const { return m_takeoffTimePlanned.toString("hh:mm"); }
+
+            //! Get actual takeoff time (actual)
+            const QDateTime &getTakeoffTimeActual() const { return m_takeoffTimeActual; }
+
+            //! Get actual takeoff time (actual)
+            QString getTakeoffTimeActualHourMin() const { return m_takeoffTimeActual.toString("hh:mm"); }
 
             //! Get planned enroute flight time
             const PhysicalQuantities::CTime &getEnrouteTime() const { return m_enrouteTime; }
 
+            //! Get planned enroute flight time
+            QString getEnrouteTimeHourMin() const { return m_enrouteTime.valueRoundedWithUnit(BlackMisc::PhysicalQuantities::CTimeUnit::hrmin()); }
+
             //! Get amount of fuel load in time
             const PhysicalQuantities::CTime &getFuelTime() const { return m_fuelTime; }
 
-            //! Get planned cruise altitude
+            //! Get amount of fuel load in time
-            const CAltitude &getCruiseAltitude() const { return m_cruiseAltitude; }
+            QString getFuelTimeHourMin() const { return m_enrouteTime.valueRoundedWithUnit(BlackMisc::PhysicalQuantities::CTimeUnit::hrmin()); }
+
+            //! Cruising altitudes
+            const BlackMisc::Aviation::CAltitude &getCruiseAltitude() const { return m_cruiseAltitude; }
 
             //! Get planned cruise TAS
             const PhysicalQuantities::CSpeed &getCruiseTrueAirspeed() const { return m_cruiseTrueAirspeed; }
@@ -167,9 +198,9 @@ namespace BlackMisc
         private:
             BLACK_ENABLE_TUPLE_CONVERSION(CFlightPlan)
             QString m_equipmentIcao;
-            QString m_originAirportIcao;
+            CAirportIcao m_originAirportIcao;
-            QString m_destinationAirportIcao;
+            CAirportIcao m_destinationAirportIcao;
-            QString m_alternateAirportIcao;
+            CAirportIcao m_alternateAirportIcao;
             QDateTime m_takeoffTimePlanned;
             QDateTime m_takeoffTimeActual;
             PhysicalQuantities::CTime m_enrouteTime;
@@ -185,6 +216,6 @@ namespace BlackMisc
 
 Q_DECLARE_METATYPE(BlackMisc::Aviation::CFlightPlan)
 BLACK_DECLARE_TUPLE_CONVERSION(BlackMisc::Aviation::CFlightPlan, (o.m_equipmentIcao, o.m_originAirportIcao, o.m_destinationAirportIcao, o.m_alternateAirportIcao,
-    o.m_takeoffTimePlanned, o.m_takeoffTimeActual, o.m_enrouteTime, o.m_fuelTime, o.m_cruiseAltitude/*, tie(o.m_cruiseTrueAirspeed, o.m_flightRules, o.m_route, o.m_remarks)*/))
+                               o.m_takeoffTimePlanned, o.m_takeoffTimeActual, o.m_enrouteTime, o.m_fuelTime, o.m_cruiseAltitude/*, tie(o.m_cruiseTrueAirspeed, o.m_flightRules, o.m_route, o.m_remarks)*/))
 
 #endif // guard