Files
pilotclient/src/blackmisc/aviation/flightplan.h
2021-10-11 14:20:07 +01:00

510 lines
21 KiB
C++

/* Copyright (C) 2013
* swift project Community / Contributors
*
* This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
* directory of this distribution. No part of swift project, including this file, may be copied, modified, propagated,
* or distributed except according to the terms contained in the LICENSE file.
*/
//! \file
#ifndef BLACKMISC_AVIATION_FLIGHTPLAN_H
#define BLACKMISC_AVIATION_FLIGHTPLAN_H
#include "blackmisc/aviation/airporticaocode.h"
#include "blackmisc/aviation/aircrafticaocode.h"
#include "blackmisc/aviation/altitude.h"
#include "blackmisc/aviation/airlineicaocode.h"
#include "blackmisc/aviation/callsign.h"
#include "blackmisc/aviation/selcal.h"
#include "blackmisc/network/voicecapabilities.h"
#include "blackmisc/network/url.h"
#include "blackmisc/pq/speed.h"
#include "blackmisc/pq/time.h"
#include "blackmisc/pq/units.h"
#include "blackmisc/statusmessagelist.h"
#include "blackmisc/logcategories.h"
#include "blackmisc/timestampbased.h"
#include "blackmisc/valueobject.h"
#include "blackmisc/metaclass.h"
#include "blackmisc/blackmiscexport.h"
#include <QDateTime>
#include <QMetaType>
#include <QString>
#include <QTime>
#include <QtGlobal>
BLACK_DECLARE_VALUEOBJECT_MIXINS(BlackMisc::Aviation, CFlightPlanRemarks)
BLACK_DECLARE_VALUEOBJECT_MIXINS(BlackMisc::Aviation, CFlightPlan)
namespace BlackMisc::Aviation
{
//! Flight plan remarks, parsed values
//! \remark Actually the term "remarks" is not accurate, as the FP remarks are normally only the /RMK part of a flight plan.
//! But on flight sim. networks "remarks" is used to fill in all parts not fitting in other fields.
//! The correct term would be ITEM18 ("OTHER INFORMATION") or ITEM19 ("SUPPLEMENTARY INFORMATION")
//! according to https://www.skybrary.aero/index.php/Flight_Plan_Filling
class BLACKMISC_EXPORT CFlightPlanRemarks : public CValueObject<CFlightPlanRemarks>
{
public:
//! Ctor
CFlightPlanRemarks();
//! Ctor
CFlightPlanRemarks(const QString &remarks, bool parse = true);
//! Ctor
CFlightPlanRemarks(const QString &remarks, Network::CVoiceCapabilities voiceCapabilities, bool parse = true);
//! The unparsed remarks
const QString &getRemarks() const { return m_remarks; }
//! Radio telephony designator
const QString &getRadioTelephony() const { return m_radioTelephony; }
//! Operator, i.e. normally the airline name
const QString &getFlightOperator() const { return m_flightOperator; }
//! Airline ICAO if provided in flight plan
const CAirlineIcaoCode &getAirlineIcao() const { return m_airlineIcao; }
//! SELCAL code
const CSelcal &getSelcalCode() const { return m_selcalCode; }
//! SELCAL code
bool setSelcalCode(const QString &selcal);
//! Get registration (a callsign, but normally not the flight callsign)
const CCallsign &getRegistration() const { return m_registration; }
//! Voice capabilities
const Network::CVoiceCapabilities &getVoiceCapabilities() const { return m_voiceCapabilities; }
//! Set voice capabilities
void setVoiceCapabilitiesByText(const QString &text);
//! Set voice capabilities
void setVoiceCapabilities(const Network::CVoiceCapabilities &capabilities);
//! Any remarks available?
bool hasAnyParsedRemarks() const;
//! Airline remarks
bool hasParsedAirlineRemarks() const;
//! Parse remarks from a flight plan
void parseFlightPlanRemarks(bool force = false);
//! Valid airline ICAO?
//! \remark valid here means valid syntax, no guarantee it really exists
bool hasValidAirlineIcao() const { return m_airlineIcao.hasValidDesignator(); }
//! Empty remarks?
bool isEmpty() const { return m_remarks.isEmpty(); }
//! Equipment codes (ICAO)
void setIcaoEquipmentCodes(const QString &eq);
//! Already parsed?
bool isParsed() const { return m_isParsed; }
//! \copydoc BlackMisc::Mixin::String::toQString()
QString convertToQString(bool i18n = false) const;
//! Turn text into voice capabilities for remarks
static QString textToVoiceCapabilitiesRemarks(const QString &text);
//! Replace the voice capabilities remarks part
static QString replaceVoiceCapabilities(const QString &newCapRemarks, const QString &oldRemarks);
//! Clean up remarks string
static QString cleanRemarks(const QString &remarksIn);
private:
QString m_remarks; //!< the unparsed string
QString m_radioTelephony; //!< radio telephony designator
QString m_flightOperator; //!< operator, i.e. normally the airline name
CCallsign m_registration; //!< callsign of pilot
CSelcal m_selcalCode; //!< SELCAL code
CAirlineIcaoCode m_airlineIcao; //!< airline ICAO if provided in flight plan
Network::CVoiceCapabilities m_voiceCapabilities; //!< voice capabilities
bool m_isParsed = false; //!< marked as parsed
BLACK_METACLASS(
CFlightPlanRemarks,
BLACK_METAMEMBER(remarks, 0, DisabledForComparison),
BLACK_METAMEMBER(radioTelephony),
BLACK_METAMEMBER(flightOperator),
BLACK_METAMEMBER(airlineIcao),
BLACK_METAMEMBER(selcalCode),
BLACK_METAMEMBER(registration),
BLACK_METAMEMBER(isParsed),
BLACK_METAMEMBER(voiceCapabilities)
);
//! Cut the remarks part
static QString getRemark(const QString &remarks, const QString &marker);
//! Replace a remark part
static QString replaceRemark(const QString &remarks, const QString &marker, const QString &newRemark);
};
//! Value object for a flight plan
class BLACKMISC_EXPORT CFlightPlan :
public CValueObject<CFlightPlan>,
public ITimestampBased
{
public:
//! The log. catgeories
static const QStringList &getLogCategories();
//! Flight rules (VFR or IFR)
enum FlightRules
{
VFR = 0, //!< Visual flight rules
IFR, //!< Instrument flight rules
SVFR, //!< Special VFR (reserved for ATC use),
DVFR, //!< Defense VFR
UNKNOWN //!< Unknown
};
//! Properties by index
enum ColumnIndex
{
IndexCallsign = CPropertyIndexRef::GlobalIndexCFlightPlan,
IndexOriginAirportIcao,
IndexDestinationAirportIcao,
IndexAlternateAirportIcao,
IndexRemarks
};
//! \fixme max.length of complete flight plan is 768 characters, this here is an assumption and should be part of the underlying network layers
// https://forums.vatsim.net/viewtopic.php?f=6&t=63416
static constexpr int MaxRemarksLength = 512; //!< Max.remarks length
static constexpr int MaxRouteLength = 512; //!< Max.route length
static constexpr int MaxRouteAndRemarksLength = 624; //!< Max.length for Route and Remarks
//! Default constructor
CFlightPlan();
//! Constructor
CFlightPlan(const CCallsign &callsign,
const QString &equipmentIcao, const CAirportIcaoCode &originAirportIcao, const CAirportIcaoCode &destinationAirportIcao, const CAirportIcaoCode &alternateAirportIcao,
const QDateTime &takeoffTimePlanned, const 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);
//! Callsign (of aircraft)
void setCallsign(const CCallsign &callsign);
//! Set single char ICAO aircraft equipment code like used in "T/A320/F" (here "F")
//! \remark function can handle full codes like "T/A320/F" of just the "F"
void setEquipmentIcao(const QString &equipmentIcao);
//! Set origin airport ICAO code
void setOriginAirportIcao(const QString &originAirportIcao) { m_originAirportIcao = originAirportIcao; }
//! Set origin airport ICAO code
void setOriginAirportIcao(const CAirportIcaoCode &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 CAirportIcaoCode &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 CAirportIcaoCode &alternateAirportIcao) { m_alternateAirportIcao = alternateAirportIcao; }
//! Set planned takeoff time
void setTakeoffTimePlanned(const QDateTime &takeoffTimePlanned);
//! Set planned takeoff time hh:mm
void setTakeoffTimePlanned(const QString &time) { m_takeoffTimePlanned = QDateTime::currentDateTimeUtc(); m_takeoffTimePlanned.setTime(QTime::fromString(time, "hh:mm"));}
//! Set actual takeoff time (reserved for ATC use)
void setTakeoffTimeActual(const QDateTime &takeoffTimeActual);
//! Set actual takeoff time hh:mm
void setTakeoffTimeActual(const 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; m_enrouteTime.switchUnit(BlackMisc::PhysicalQuantities::CTimeUnit::hrmin());}
//! Set amount of fuel load in time
void setFuelTime(const PhysicalQuantities::CTime &fuelTime) { m_fuelTime = fuelTime; m_fuelTime.switchUnit(BlackMisc::PhysicalQuantities::CTimeUnit::hrmin());}
//! 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; m_cruiseAltitudeString.clear(); }
//! Cruising altitude already as string
void setCruiseAltitudeString(const QString &altitudeString) { m_cruiseAltitudeString = altitudeString; }
//! Set planned cruise TAS
void setCruiseTrueAirspeed(const PhysicalQuantities::CSpeed &cruiseTrueAirspeed) { m_cruiseTrueAirspeed = cruiseTrueAirspeed; }
//! Set flight rules (VFR or IFR)
void setFlightRule(FlightRules flightRule) { m_flightRules = flightRule; }
//! Set flight rules (VFR or IFR)
void setFlightRule(const QString &flightRule);
//! Set route string
void setRoute(const QString &route);
//! Set remarks string (max 100 characters)
void setRemarks(const QString &remarks);
//! Set voice capabilities
void setVoiceCapabilities(const QString &capabilities);
//! When last sent
void setWhenLastSentOrLoaded(const QDateTime &dateTime) { this->setUtcTimestamp(dateTime); }
//! Aircraft callsign
const CCallsign &getCallsign() const { return m_callsign; }
//! Has callsign?
bool hasCallsign() const { return !m_callsign.isEmpty(); }
//! Get origin airport ICAO code
const CAirportIcaoCode &getOriginAirportIcao() const { return m_originAirportIcao; }
//! Get destination airport ICAO code
const CAirportIcaoCode &getDestinationAirportIcao() const { return m_destinationAirportIcao; }
//! Get alternate destination airport ICAO code
const CAirportIcaoCode &getAlternateAirportIcao() const { return m_alternateAirportIcao; }
//! Get planned takeoff time (planned)
const QDateTime &getTakeoffTimePlanned() const { return m_takeoffTimePlanned; }
//! Get planned takeoff time (planned)
QString getTakeoffTimePlannedHourMin() const;
//! Get actual takeoff time (actual)
const QDateTime &getTakeoffTimeActual() const { return m_takeoffTimeActual; }
//! Get actual takeoff time (actual)
QString getTakeoffTimeActualHourMin() const;
//! 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(PhysicalQuantities::CTimeUnit::hrmin()); }
//! Get amount of fuel load in time
const PhysicalQuantities::CTime &getFuelTime() const { return m_fuelTime; }
//! Get amount of fuel load in time
QString getFuelTimeHourMin() const { return m_fuelTime.valueRoundedWithUnit(PhysicalQuantities::CTimeUnit::hrmin()); }
//! Cruising altitudes
const CAltitude &getCruiseAltitude() const { return m_cruiseAltitude; }
//! Cruising altitude already as string
const QString &getCruiseAltitudeString() const { return m_cruiseAltitudeString; }
//! Get planned cruise TAS
const PhysicalQuantities::CSpeed &getCruiseTrueAirspeed() const { return m_cruiseTrueAirspeed; }
//! Get flight rules as in FlightRules
FlightRules getFlightRules() const { return m_flightRules; }
//! Rules only as IFR or VFR
FlightRules getFlightRulesAsVFRorIFR() const;
//! Get flight rules as in FlightRules as string
QString getFlightRulesAsString() const { return CFlightPlan::flightRulesToString(this->getFlightRules()); }
//! Get route string
const QString &getRoute() const { return m_route; }
//! When last sent
const QDateTime whenLastSentOrLoaded() const { return this->getUtcTimestamp() ; }
//! Flight plan already sent
bool wasSentOrLoaded() const { return this->hasValidTimestamp(); }
//! Received before n ms
qint64 timeDiffSentOrLoadedMs() const { return this->msecsToNow(); }
//! Get remarks string
const QString &getRemarks() const { return m_remarks.getRemarks(); }
//! Get the parsable remarks
const CFlightPlanRemarks &getFlightPlanRemarks() const { return m_remarks; }
//! Set FP remarks
void setFlightPlanRemarks(const CFlightPlanRemarks &remarks) { m_remarks = remarks; }
//! Get ICAO aircraft equipment prefix H/B737/F "H"
const QString &getPrefix() const { return m_prefix; }
//! Set ICAO aircraft equipment prefix H/B737/F "H"
void setPrefix(const QString &prefix);
//! Mark as heavy
void setHeavy();
//! Get ICAO aircraft equipment suffix H/B737/F "F"
const QString &getEquipmentSuffix() const { return m_equipmentSuffix; }
//! Set ICAO aircraft equipment suffix H/B737/F "F"
void setEquipmentSuffix(const QString &suffix);
//! Get aircraft ICAO H/B737/F "B737"
const CAircraftIcaoCode &getAircraftIcao() const { return m_aircraftIcao; }
//! Set aircraft ICAO code H/B737/F "B737"
void setAircraftIcao(const CAircraftIcaoCode &icao) { m_aircraftIcao = icao; }
//! Has aircraft ICAO?
bool hasAircraftIcao() const { return m_aircraftIcao.hasDesignator(); }
//! Full string like "H/B737/F"
QString getCombinedPrefixIcaoSuffix() const;
//! \copydoc BlackMisc::Mixin::Index::propertyByIndex
QVariant propertyByIndex(CPropertyIndexRef index) const;
//! \copydoc BlackMisc::Mixin::Index::setPropertyByIndex
void setPropertyByIndex(CPropertyIndexRef index, const QVariant &variant);
//! \copydoc BlackMisc::Mixin::Icon::toIcon
CIcons::IconIndex toIcon() const;
//! \copydoc BlackMisc::Mixin::String::toQString()
QString convertToQString(bool i18n = false) const;
//! As HTML
QString asHTML(bool i18n = false) const;
//! From vPilot data
static CFlightPlan fromVPilotFormat(const QString &vPilotData);
//! From SB4 data
static CFlightPlan fromSB4Format(const QString &sbData);
//! From SimBrief format (XML)
static CFlightPlan fromSimBriefFormat(const QString &simBrief);
//! From multiple formats
static CFlightPlan fromMultipleFormats(const QString &data, const QString &fileSuffix);
//! From multiple formats
static CFlightPlan fromMultipleFormatsNoThrow(const QString &data, const QString &fileSuffix);
//! Load from multiple formats
static CFlightPlan loadFromMultipleFormats(const QString &fileName, CStatusMessageList *msgs = nullptr);
//! Rules to string
static const QString &flightRulesToString(FlightRules rules);
//! String to flight rules
static FlightRules stringToFlightRules(const QString &flightRules);
//! All rules as string
static const QStringList &flightRules();
//! Is rule a VFR rule?
//! @{
static bool isVFRRules(FlightRules rule);
static bool isVFRRules(const QString &rule);
//! @}
//! Is rule a IFR rule?
//! @{
static bool isIFRRules(FlightRules rule);
static bool isIFRRules(const QString &rule);
//! @}
//! Get aircraft ICAO code from equipment code like
//! \remark we expect something like "H/B772/F" "B773" "B773/F"
static QString aircraftIcaoCodeFromEquipmentCode(const QString &equipmentCodeAndAircraft);
//! Get the 3 parts of "H/B772/F", returned as prefix, ICAO, suffix
static QStringList splitEquipmentCode(const QString &equipmentCodeAndAircraft);
//! Concat the 3 parts to "H/B772/F"
static QString concatPrefixIcaoSuffix(const QString &prefix, const QString &icao, const QString &suffix);
//! Equipment codes 1 character
static const QStringList &faaEquipmentCodes();
//! Codes plus info
static const QStringList &faaEquipmentCodesInfo();
//! SquawkBox equipment codes
static const QStringList &squawkBoxEquipmentCodes();
//! Codes plus info
static const QStringList &squawkBoxEquipmentCodesInfo();
//! All equipment codes
static const QStringList &equipmentCodes();
//! Equipment codes info
static const QStringList &equipmentCodesInfo();
//! Prefix codes "H" .. Heavy, "T" .. TCAS
static const QStringList &prefixCodes();
private:
CCallsign m_callsign; //!< aircraft callsign
CAircraftIcaoCode m_aircraftIcao; //!< Aircraft ICAO code
QString m_prefix; //!< e.g. "T/A320/F" -> the "T"
QString m_equipmentSuffix; //!< e.g. "T/A320/F" -> the "F"
CAirportIcaoCode m_originAirportIcao;
CAirportIcaoCode m_destinationAirportIcao;
CAirportIcaoCode m_alternateAirportIcao;
QDateTime m_takeoffTimePlanned;
QDateTime m_takeoffTimeActual;
PhysicalQuantities::CTime m_enrouteTime;
PhysicalQuantities::CTime m_fuelTime;
CAltitude m_cruiseAltitude;
QString m_cruiseAltitudeString;
PhysicalQuantities::CSpeed m_cruiseTrueAirspeed;
FlightRules m_flightRules;
QString m_route;
CFlightPlanRemarks m_remarks;
//! As string
QString buildString(bool i18n = false, const QString &separator = " ") const;
BLACK_METACLASS(
CFlightPlan,
// callsign will be current flight
BLACK_METAMEMBER(aircraftIcao),
BLACK_METAMEMBER(prefix),
BLACK_METAMEMBER(equipmentSuffix),
BLACK_METAMEMBER(originAirportIcao),
BLACK_METAMEMBER(destinationAirportIcao),
BLACK_METAMEMBER(alternateAirportIcao),
BLACK_METAMEMBER(takeoffTimePlanned),
BLACK_METAMEMBER(takeoffTimeActual),
BLACK_METAMEMBER(enrouteTime, 0, LosslessMarshalling),
BLACK_METAMEMBER(fuelTime, 0, LosslessMarshalling),
BLACK_METAMEMBER(cruiseAltitude, 0, LosslessMarshalling),
BLACK_METAMEMBER(cruiseAltitudeString),
BLACK_METAMEMBER(cruiseTrueAirspeed, 0, LosslessMarshalling),
BLACK_METAMEMBER(flightRules),
BLACK_METAMEMBER(route),
BLACK_METAMEMBER(remarks),
BLACK_METAMEMBER(timestampMSecsSinceEpoch)
);
};
} // namespace
Q_DECLARE_METATYPE(BlackMisc::Aviation::CFlightPlanRemarks)
Q_DECLARE_METATYPE(BlackMisc::Aviation::CFlightPlan)
#endif // guard