A list of NOTAMs. More...

#include <NOTAMList.h>

Public Member Functions
	NOTAMList ()=default
	Constructs an empty NOTAMList.

	NOTAMList (const QJsonDocument &jsonDoc, const QGeoCircle &region, QSet< QString > *cancelledNotamNumbers=nullptr)
	Constructs a NOTAMList from FAA GeoJSON data.

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

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

Q_REQUIRED_RESULT QList< NOTAM >	notams () const
	Getter function for the property with the same name.

Q_REQUIRED_RESULT QGeoCircle	region () const
	Getter function for the property with the same name.

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

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

Q_REQUIRED_RESULT Units::Timespan	age () const
	Time span between retrieved and now.

Q_REQUIRED_RESULT NOTAMList	cleaned (const QSet< QString > &cancelledNotamNumbers) const
	Sublist with expired and duplicated entries removed.

Q_REQUIRED_RESULT bool	isOutdated () const
	Check if outdated.

Q_REQUIRED_RESULT bool	needsUpdate () const
	Check if list needs update.

Q_REQUIRED_RESULT NOTAMList	restricted (const GeoMaps::Waypoint &waypoint) const
	Sublist of notams relevant to a given waypoint.

Static Public Attributes
static constexpr Units::Distance	restrictionRadius = Units::Distance::fromNM(20.0)
	Radius used in the method restricted()

Properties
bool	isEmpty
	Emptyness.

bool	isValid
	Validity.

QList< NOTAM >	notams
	List of Notams.

QGeoCircle	region
	Region covered by this list.

QDateTime	retrieved
	Date of retrieval.

QString	summary
	One-line summary.

Friends
QDataStream &	operator<< (QDataStream &stream, const NOTAMList &notamList)
	Serialization.

QDataStream &	operator>> (QDataStream &stream, NOTAMList &notamList)
	Deserialization.

Detailed Description

A list of NOTAMs.

This class holds a holds the result of a NOTAM request for a specific region. The class stores the time of the request in the member m_retrieved, and the region in the member m_region.

Definition at line 39 of file NOTAMList.h.

Constructor & Destructor Documentation

◆ NOTAMList() [1/2]

NOTAM::NOTAMList::NOTAMList ( )

default

Constructs an empty NOTAMList.

Constructs an empty NOTAMList with an invalid region and an invalid QDateTime for the property retrieved.

◆ NOTAMList() [2/2]

NOTAM::NOTAMList::NOTAMList	(	const QJsonDocument &	jsonDoc,
		const QGeoCircle &	region,
		QSet< QString > *	cancelledNotamNumbers = nullptr )

Constructs a NOTAMList from FAA GeoJSON data.

This constructor sets the member m_retrieved to QDateTime::currentDateTimeUtc(). Invalid Notams and Cancel Notams will not be added to the list.

Parameters

jsonDoc	JSON dociment, as provided by the FAA
region	Geographic region covered by this notam list
cancelledNotamNumbers	Pointer to a set where numbers of cancelled Notams are added. The nullptr is allowed.

Member Function Documentation

◆ age()

Q_REQUIRED_RESULT Units::Timespan NOTAM::NOTAMList::age ( ) const

Time span between retrieved and now.

Returns: Time span between retrieved and now. If retrieved() is invalid, and invalid time is returned.

◆ cleaned()

Q_REQUIRED_RESULT NOTAMList NOTAM::NOTAMList::cleaned ( const QSet< QString > & cancelledNotamNumbers ) const

Sublist with expired and duplicated entries removed.

Parameters

cancelledNotamNumbers Set with numbers of notams that are known as cancelled

Returns: Sublist with expired and duplicated entries removed.

◆ isEmpty()

Q_REQUIRED_RESULT bool NOTAM::NOTAMList::isEmpty ( ) const

inline

Getter function for the property with the same name.

Returns: Property isEmpty

Definition at line 102 of file NOTAMList.h.

◆ isOutdated()

Q_REQUIRED_RESULT bool NOTAM::NOTAMList::isOutdated ( ) const

inline

Check if outdated.

A NOTAMList is outdated if its age is invalid or greater than 24h

Returns: True if outdated

Definition at line 162 of file NOTAMList.h.

◆ isValid()

Q_REQUIRED_RESULT bool NOTAM::NOTAMList::isValid ( ) const

inline

Getter function for the property with the same name.

Returns: Property isValid

Definition at line 108 of file NOTAMList.h.

◆ needsUpdate()

Q_REQUIRED_RESULT bool NOTAM::NOTAMList::needsUpdate ( ) const

inline

Check if list needs update.

A NOTAMList needs an update if its age is invalid or greater than 12h

Returns: True if outdated

Definition at line 170 of file NOTAMList.h.

◆ notams()

Q_REQUIRED_RESULT QList< NOTAM > NOTAM::NOTAMList::notams ( ) const

inline

Getter function for the property with the same name.

Returns: Property notams

Definition at line 114 of file NOTAMList.h.

◆ region()

Q_REQUIRED_RESULT QGeoCircle NOTAM::NOTAMList::region ( ) const

inline

Getter function for the property with the same name.

Returns: Property region

Definition at line 120 of file NOTAMList.h.

◆ restricted()

Q_REQUIRED_RESULT NOTAMList NOTAM::NOTAMList::restricted ( const GeoMaps::Waypoint & waypoint ) const

Sublist of notams relevant to a given waypoint.

Parameters

waypoint Waypoint

Returns: NOTAMList with all notams centered within restrictionRadius of the given waypoint, without expired and duplicated NOTAMs. Section titles are set depending on the current time, using NOTAM::updateSectionTitle().

◆ retrieved()

Q_REQUIRED_RESULT QDateTime NOTAM::NOTAMList::retrieved ( ) const

inline

Getter function for the property with the same name.

Returns: Property retrieved

Definition at line 126 of file NOTAMList.h.

◆ summary()

Q_REQUIRED_RESULT QString NOTAM::NOTAMList::summary ( ) const

Getter function for the property with the same name.

Returns: Property summary

Friends And Related Symbol Documentation

◆ operator<<

QDataStream & operator<<	(	QDataStream &	stream,
		const NOTAMList &	notamList )

friend

Serialization.

There is no checks for errors of any kind.

◆ operator>>

QDataStream & operator>>	(	QDataStream &	stream,
		NOTAMList &	notamList )

friend

Deserialization.

There is no checks for errors of any kind.

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

/home/runner/work/enroute/enroute/src/notam/NOTAMList.h

Public Member Functions

Static Public Attributes

Properties

Friends

Detailed Description

Constructor & Destructor Documentation

◆ NOTAMList() [1/2]

◆ NOTAMList() [2/2]

Member Function Documentation

◆ age()

◆ cleaned()

◆ isEmpty()

◆ isOutdated()

◆ isValid()

◆ needsUpdate()

◆ notams()

◆ region()

◆ restricted()

◆ retrieved()

◆ summary()

Friends And Related Symbol Documentation

◆ operator<<

◆ operator>>