METAR report. More...

#include <METAR.h>

Public Types
enum	FlightCategory : quint8 { VFR , MVFR , IFR , LIFR , unknown }
	Flight category. More...

Public Member Functions
	METAR ()=default
	Default constructor.

	METAR (QXmlStreamReader &xml)
	Deserialization constructor.

	~METAR ()=default
	Destructor.

	METAR (const METAR &)=default
	Copy constructor.

	METAR (METAR &&)=default
	Move constructor.

METAR &	operator= (const METAR &)=default
	Copy assignment operator.

METAR &	operator= (METAR &&)=default
	Move assignment operator.

bool	operator== (const METAR &other) const =default
	Equality check.

QGeoCoordinate	coordinate () const
	Getter function for property with the same name.

QDateTime	expiration () const
	Getter function for property with the same name.

QString	flightCategoryColor () const
	Getter function for property with the same name.

FlightCategory	flightCategory () const
	Getter function for property with the same name.

QString	ICAOCode () const
	Getter function for property with the same name.

bool	isValid () const
	Getter function for property with the same name.

QDateTime	observationTime () const
	Getter function for property with the same name.

Units::Pressure	QNH () const
	Getter function for property with the same name.

QString	rawText () const
	Getter function for property with the same name.

Q_INVOKABLE QString	decodedText (const Navigation::Aircraft &act, const QDateTime &time)
	Decoded METAR text.

Q_INVOKABLE QString	derivedData (const Navigation::Aircraft &aircraft, bool showPerformanceWarning, bool explainPerformanceWarning) const
	Derived data, such as density height.

Q_INVOKABLE QString	summary (const Navigation::Aircraft &aircraft, const QDateTime &currentTime) const
	One-line summary of the METAR.

Properties
QGeoCoordinate	coordinate
	Geographical coordinate of the station reporting this METAR.

QDateTime	expiration
	Expiration time and date.

QString	flightCategoryColor
	Suggested color describing the flight category for this METAR.

FlightCategory	flightCategory
	Flight category for this METAR.

QString	ICAOCode
	ICAO code of the station reporting this METAR.

bool	isValid
	Indicates if the class represents a valid METAR report.

QDateTime	observationTime
	Observation time of this METAR.

Units::Pressure	QNH
	QNH value in this METAR.

QString	rawText
	Raw METAR text.

Friends
QDataStream &	operator<< (QDataStream &stream, const METAR &metar)
	Serialization.

QDataStream &	operator>> (QDataStream &stream, METAR &metar)
	Deserialization.

Detailed Description

METAR report.

This class contains the data of a METAR report and provides a few methods to access the data. Instances of this class are provided by the WeatherDataProvider class; there is no way to construct valid instances yourself.

Definition at line 47 of file METAR.h.

Member Enumeration Documentation

◆ FlightCategory

enum Weather::METAR::FlightCategory : quint8

Flight category.

Flight category, as defined in https://www.aviationweather.gov/metar/help?page=plot#fltcat

Enumerator
VFR	Visual Flight Rules
MVFR	Marginal Visual Flight Rules
IFR	Instrument Flight Rules
LIFR	Low Instrument Flight Rules
unknown	Unknown conditions

Definition at line 61 of file METAR.h.

Constructor & Destructor Documentation

◆ METAR()

Weather::METAR::METAR ( QXmlStreamReader & xml )

explicit

Deserialization constructor.

This constructor reads a XML stream, as provided by the Aviation Weather Center's Text Data Server, https://www.aviationweather.gov/dataserver

Parameters

xml	XML Stream reader

Member Function Documentation

◆ coordinate()

QGeoCoordinate Weather::METAR::coordinate ( ) const

inlinenodiscard

Getter function for property with the same name.

Returns: Property coordiante

Definition at line 191 of file METAR.h.

◆ decodedText()

Q_INVOKABLE QString Weather::METAR::decodedText	(	const Navigation::Aircraft &	act,
		const QDateTime &	time )

inlinenodiscard

Decoded METAR text.

Parameters

act	Current aircraft, used to determine appropriate units
time	Current time, used to describe points in time

Returns: Human-readable, translated rich text.

Definition at line 272 of file METAR.h.

◆ derivedData()

Q_INVOKABLE QString Weather::METAR::derivedData	(	const Navigation::Aircraft &	aircraft,
		bool	showPerformanceWarning,
		bool	explainPerformanceWarning ) const

nodiscard

Derived data, such as density height.

Parameters

aircraft	Current aircraft, used to determine appropriate units
showPerformanceWarning	If true, then show warning if density altitude severely affect aircraft performance.
explainPerformanceWarning	If true, add text to explain performance degrade

Returns: Human-readable, translated rich text. The text contains two links, to 'hidePerformanceWarning' and 'hideExplanation'. When clicked, the user-facing text should be replaced, if the appropriate parameter set to 'false'.

◆ expiration()

QDateTime Weather::METAR::expiration ( ) const

nodiscard

Getter function for property with the same name.

Returns: Property expiration

◆ flightCategory()

FlightCategory Weather::METAR::flightCategory ( ) const

inlinenodiscard

Getter function for property with the same name.

Returns: Property flightCategory

Definition at line 212 of file METAR.h.

◆ flightCategoryColor()

QString Weather::METAR::flightCategoryColor ( ) const

nodiscard

Getter function for property with the same name.

Returns: Property flightCategoryColor

◆ ICAOCode()

QString Weather::METAR::ICAOCode ( ) const

inlinenodiscard

Getter function for property with the same name.

Returns: Property ICAOCode

Definition at line 221 of file METAR.h.

◆ isValid()

bool Weather::METAR::isValid ( ) const

nodiscard

Getter function for property with the same name.

Returns: Property isValid

◆ observationTime()

QDateTime Weather::METAR::observationTime ( ) const

inlinenodiscard

Getter function for property with the same name.

Returns: Property observationTime

Definition at line 236 of file METAR.h.

◆ operator=() [1/2]

METAR & Weather::METAR::operator= ( const METAR & )

default

Copy assignment operator.

Returns: Reference to self

◆ operator=() [2/2]

METAR & Weather::METAR::operator= ( METAR && )

default

Move assignment operator.

Returns: Reference to self

◆ operator==()

bool Weather::METAR::operator== ( const METAR & other ) const

default

Equality check.

Parameters

other Other METAR to compare with

Returns: True on equality

◆ QNH()

Units::Pressure Weather::METAR::QNH ( ) const

inlinenodiscard

Getter function for property with the same name.

Returns: Property qnh

Definition at line 245 of file METAR.h.

◆ rawText()

QString Weather::METAR::rawText ( ) const

inlinenodiscard

Getter function for property with the same name.

Returns: Property extendedName

Definition at line 254 of file METAR.h.

◆ summary()

Q_INVOKABLE QString Weather::METAR::summary	(	const Navigation::Aircraft &	aircraft,
		const QDateTime &	currentTime ) const

nodiscard

One-line summary of the METAR.

Parameters

aircraft	Current aircraft, used to determine appropriate units
currentTime	Current time, used to describe time difference

Returns: A translated, human-readable string of the form "METAR 14min ago: marginal VMC • wind at 15kt • rain"

Friends And Related Symbol Documentation

◆ operator<<

QDataStream & operator<<	(	QDataStream &	stream,
		const METAR &	metar )

friend

Serialization.

There are no checks for errors of any kind.

◆ operator>>

QDataStream & operator>>	(	QDataStream &	stream,
		METAR &	metar )

friend

Deserialization.

There are no checks for errors of any kind.

Property Documentation

◆ coordinate

QGeoCoordinate Weather::METAR::coordinate

read

Geographical coordinate of the station reporting this METAR.

If the station coordinate is unknown, the property contains an invalid coordinate. Typically, the coordinate will contain the elevation of the station.

Definition at line 129 of file METAR.h.

◆ expiration

QDateTime Weather::METAR::expiration

read

Expiration time and date.

A METAR message is supposed to expire 1.5 hours after observation time, unless raw text contains "NOSIG", then it is 3 hours.

Definition at line 136 of file METAR.h.

◆ flightCategoryColor

QString Weather::METAR::flightCategoryColor

read

Suggested color describing the flight category for this METAR.

The suggested colors are the following

"green" for VFR
"yellow" for MVFR
"red" for "IFR" and "LIFR"
"transparant" for "unknown"

Definition at line 150 of file METAR.h.

◆ ICAOCode

QString Weather::METAR::ICAOCode

read

ICAO code of the station reporting this METAR.

This is a string such as "LSZB" for Bern/Belp airport. If the station code is unknown, the property contains an empty string.

Definition at line 160 of file METAR.h.

◆ QNH

Units::Pressure Weather::METAR::QNH

read

QNH value in this METAR.

The QNH property is set to NaN if no QNH is known. Otherwise, the values is guaranteed to lie in the interval [800 … 1200]

Definition at line 173 of file METAR.h.

◆ rawText

QString Weather::METAR::rawText

read

Raw METAR text.

This is a string such as "METAR EICK 092100Z 23007KT 9999 FEW038 BKN180 11/08 Q1019 NOSIG=".

Definition at line 180 of file METAR.h.

The documentation for this class was generated from the following file:

/home/runner/work/enroute/enroute/src/weather/METAR.h

Public Types

Public Member Functions

Properties

Friends

Detailed Description

Member Enumeration Documentation

◆ FlightCategory

Constructor & Destructor Documentation

◆ METAR()

Member Function Documentation

◆ coordinate()

◆ decodedText()

◆ derivedData()

◆ expiration()

◆ flightCategory()

◆ flightCategoryColor()

◆ ICAOCode()

◆ isValid()

◆ observationTime()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ QNH()

◆ rawText()

◆ summary()

Friends And Related Symbol Documentation

◆ operator<<

◆ operator>>

Property Documentation

◆ coordinate

◆ expiration

◆ flightCategoryColor

◆ ICAOCode

◆ QNH

◆ rawText