Manage NOTAM data and download NOTAM data from the FAA if required. More...

#include <NOTAMProvider.h>

Inheritance diagram for NOTAM::NOTAMProvider:

Public Member Functions
void	deferredInitialization () override
	Non-constructor initialization.

	~NOTAMProvider () override
	Standard destructor.

Q_REQUIRED_RESULT QByteArray	geoJSON () const
	Getter function for property with the same name.

Q_REQUIRED_RESULT QBindable< QByteArray >	bindableGeoJSON () const
	Getter function for property with the same name.

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

Q_REQUIRED_RESULT QBindable< QDateTime >	bindableLastUpdate () const
	Getter function for the property with the same name.

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

Q_REQUIRED_RESULT QBindable< QString >	bindableStatus () const
	Getter function for the property with the same name.

Q_REQUIRED_RESULT Q_INVOKABLE NOTAMList	notams (const GeoMaps::Waypoint &waypoint)
	NOTAMs for a given waypoint.

Q_REQUIRED_RESULT Q_INVOKABLE bool	isRead (const QString &number) const
	Check if a NOTAM number is registred as read.

Q_INVOKABLE void	setRead (const QString &number, bool read)
	Register NOTAM number as read or unread.

Public Member Functions inherited from GlobalObject
	GlobalObject (QObject *parent=nullptr)
	Standard constructor.

	~GlobalObject () override=default
	Standard deconstructor.

Properties
QByteArray	geoJSON
	List of NOTAM points.

QDateTime	lastUpdate
	Time of last database update.

QString	status
	Status.

Additional Inherited Members
Static Public Member Functions inherited from GlobalObject
static void	clear ()
	Deletes all globally defined objects.

static Q_INVOKABLE bool	canConstruct ()
	Indicates if the static methods are ready to be used.

static Q_INVOKABLE Navigation::Clock *	clock ()
	Pointer to appplication-wide static Navigation::Clock instance.

static Q_INVOKABLE DataManagement::DataManager *	dataManager ()
	Pointer to appplication-wide static GeoMaps::DataManager instance.

static Q_INVOKABLE DemoRunner *	demoRunner ()
	Pointer to appplication-wide static DemoRunner instance.

static Q_INVOKABLE Traffic::FlarmnetDB *	flarmnetDB ()
	Pointer to appplication-wide static FlarmnetDB instance.

static Q_INVOKABLE Platform::FileExchange_Abstract *	fileExchange ()
	Pointer to appplication-wide static FileExchange instance.

static Q_INVOKABLE GeoMaps::GeoMapProvider *	geoMapProvider ()
	Pointer to appplication-wide static GeoMaps::GeoMapProvider instance.

static Q_INVOKABLE GlobalSettings *	globalSettings ()
	Pointer to appplication-wide static Settings instance.

static Q_INVOKABLE Librarian *	librarian ()
	Pointer to appplication-wide static librarian instance.

static Q_INVOKABLE Platform::PlatformAdaptor_Abstract *	platformAdaptor ()
	Pointer to appplication-wide static PlatformAdaptor instance.

static Q_INVOKABLE Sensors *	sensors ()
	Pointer to appplication-wide static Navigation::Clock instance.

static Q_INVOKABLE Navigation::Navigator *	navigator ()
	Pointer to appplication-wide static Navigation::Navigator instance.

static Q_INVOKABLE Traffic::PasswordDB *	passwordDB ()
	Pointer to appplication-wide static PasswordDB instance.

static Q_INVOKABLE Positioning::PositionProvider *	positionProvider ()
	Pointer to appplication-wide static PositionProvider instance.

static Q_INVOKABLE NOTAM::NOTAMProvider *	notamProvider ()
	Pointer to appplication-wide static notification manager instance.

static Q_INVOKABLE Notifications::NotificationManager *	notificationManager ()
	Pointer to appplication-wide static notification manager instance.

static Q_INVOKABLE QNetworkAccessManager *	networkAccessManager ()
	Pointer to appplication-wide static QNetworkAccessManager instance.

static Q_INVOKABLE DataManagement::SSLErrorHandler *	sslErrorHandler ()
	Pointer to appplication-wide static QNetworkAccessManager instance.

static Q_INVOKABLE Traffic::TrafficDataProvider *	trafficDataProvider ()
	Pointer to appplication-wide static TrafficDataProvider instance.

static Q_INVOKABLE GeoMaps::WaypointLibrary *	waypointLibrary ()
	Pointer to appplication-wide static WaypointLibrary instance.

static Q_INVOKABLE Weather::WeatherDataProvider *	weatherDataProvider ()
	Pointer to appplication-wide static WeatherDataProvider instance.

Detailed Description

Manage NOTAM data and download NOTAM data from the FAA if required.

This class attempts to ensure that for any given point in time, current NOTAM data is provided for circles of radius minimumRadiusPoint around the current position and every waypoint in the flightRoute, as well as a region of at least minimumRadiusFlightRoute around the flight route.

There is API to access the data, and to request NOTAM data for arbitrary coordinates.

Definition at line 47 of file NOTAMProvider.h.

Member Function Documentation

◆ bindableGeoJSON()

Q_REQUIRED_RESULT QBindable< QByteArray > NOTAM::NOTAMProvider::bindableGeoJSON ( ) const

inline

Getter function for property with the same name.

Returns: Property geoJSON

Definition at line 118 of file NOTAMProvider.h.

◆ bindableLastUpdate()

Q_REQUIRED_RESULT QBindable< QDateTime > NOTAM::NOTAMProvider::bindableLastUpdate ( ) const

inline

Getter function for the property with the same name.

Returns: Property lastUpdate

Definition at line 130 of file NOTAMProvider.h.

◆ bindableStatus()

Q_REQUIRED_RESULT QBindable< QString > NOTAM::NOTAMProvider::bindableStatus ( ) const

inline

Getter function for the property with the same name.

Returns: Property status

Definition at line 142 of file NOTAMProvider.h.

◆ deferredInitialization()

void NOTAM::NOTAMProvider::deferredInitialization ( )

overridevirtual

Non-constructor initialization.

This method is called by the static methods that create global instances immediately after the constructor returns. This class can be re-implemented to perform initialization steps that refer to other singleton objects.

Reimplemented from GlobalObject.

◆ geoJSON()

Q_REQUIRED_RESULT QByteArray NOTAM::NOTAMProvider::geoJSON ( ) const

inline

Getter function for property with the same name.

Returns: Property geoJSON

Definition at line 112 of file NOTAMProvider.h.

◆ isRead()

Q_REQUIRED_RESULT Q_INVOKABLE bool NOTAM::NOTAMProvider::isRead ( const QString & number ) const

inline

Check if a NOTAM number is registred as read.

Parameters

number Notam number

Returns: True is notam is known as read

Definition at line 175 of file NOTAMProvider.h.

◆ lastUpdate()

Q_REQUIRED_RESULT QDateTime NOTAM::NOTAMProvider::lastUpdate ( ) const

inline

Getter function for the property with the same name.

Returns: Property lastUpdate

Definition at line 124 of file NOTAMProvider.h.

◆ notams()

Q_REQUIRED_RESULT Q_INVOKABLE NOTAMList NOTAM::NOTAMProvider::notams ( const GeoMaps::Waypoint & waypoint )

NOTAMs for a given waypoint.

The returned list is empty and has a valid property "retrieved" if the NOTAMProvider is sure that there are no relevant NOTAMs for the given waypoint.

The returned list is empty and has an invalid property "retrieved" if the NOTAMProvider has no data.

Calling this method might trigger an update of the NOTAM database. Consumers can watch the property lastUpdate to learn about database updates.

Parameters

waypoint Waypoint for which the notam list is compiled

Returns: List of NOTAMS relevant for the waypoint

◆ setRead()

Q_INVOKABLE void NOTAM::NOTAMProvider::setRead	(	const QString &	number,
		bool	read )

Register NOTAM number as read or unread.

Parameters

number	Notam number
read	True if notam is to be registred as read

◆ status()

Q_REQUIRED_RESULT QString NOTAM::NOTAMProvider::status ( ) const

inline

Getter function for the property with the same name.

Returns: Property status

Definition at line 136 of file NOTAMProvider.h.

Property Documentation

◆ geoJSON

QByteArray NOTAM::NOTAMProvider::geoJSON

read

List of NOTAM points.

This property holds GeoJSON, to describe points where NOTAMs are active.

Definition at line 87 of file NOTAMProvider.h.

◆ lastUpdate

QDateTime NOTAM::NOTAMProvider::lastUpdate

read

Time of last database update.

This is the time of the last successful data download from the FAA server. The property holds an invalid QDateTime if no data is available.

Definition at line 94 of file NOTAMProvider.h.

◆ status

QString NOTAM::NOTAMProvider::status

read

Status.

This is a translated, human-readable text with warnings about incomplete NOTAM data, or an empty string in case of no warning.

Definition at line 101 of file NOTAMProvider.h.

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

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

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ bindableGeoJSON()

◆ bindableLastUpdate()

◆ bindableStatus()

◆ deferredInitialization()

◆ geoJSON()

◆ isRead()

◆ lastUpdate()

◆ notams()

◆ setRead()

◆ status()

Property Documentation

◆ geoJSON

◆ lastUpdate

◆ status