Provides geographic information. More...

#include <GeoMapProvider.h>

Inheritance diagram for GeoMaps::GeoMapProvider:

Signals
void	geoJSONChanged ()
	Notification signal for the property with the same name.

void	styleFileURLChanged ()
	Notification signal for the property with the same name.

void	serverUrlChanged ()
	Notification signal for the property with the same name.

void	terrainMapTilesChanged ()
	Notification signal for the property with the same name.

void	waypointsChanged ()
	Notification signal for the property with the same name.

Public Member Functions
	GeoMapProvider (QObject *parent=nullptr)
	Creates a new GeoMap provider.

void	deferredInitialization () override
	Non-constructor initialization.

	~GeoMapProvider () override=default
	Destructor.

QStringList	availableRasterMaps () const
	Getter function for the property with the same name.

QBindable< QStringList >	bindableAvailableRasterMaps () const
	Getter function for the property with the same name.

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

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

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

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

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

QList< QSharedPointer< FileFormats::MBTILES > >	terrainMapTiles () const
	Getter function for the property with the same name.

QList< Waypoint >	waypoints ()
	Getter function for the property with the same name.

void	setCurrentRasterMap (const QString &mapName)
	Setter function for the property with the same name.

Q_INVOKABLE QVariantList	airspaces (const QGeoCoordinate &position)
	List of airspaces at a given location.

Q_INVOKABLE GeoMaps::Waypoint	closestWaypoint (QGeoCoordinate position, const QGeoCoordinate &distPosition)
	Find closest waypoint to a given position.

Q_INVOKABLE Units::Distance	terrainElevationAMSL (const QGeoCoordinate &coordinate)
	Elevation of terrain at a given coordinate, above sea level.

Q_INVOKABLE QVector< GeoMaps::Waypoint >	filteredWaypoints (const QString &filter)
	Waypoints containing a given substring.

Q_INVOKABLE Waypoint	findByID (const QString &icaoID)

Q_INVOKABLE QList< GeoMaps::Waypoint >	nearbyWaypoints (const QGeoCoordinate &position, const QString &type)

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

	~GlobalObject () override=default
	Standard deconstructor.

Static Public Member Functions
static QString	copyrightNotice ()
	Getter function for the property with the same name.

static Q_INVOKABLE GeoMaps::Waypoint	createWaypoint ()
	Create invalid waypoint.

static Q_INVOKABLE QByteArray	emptyGeoJSON ()
	Create empty GeoJSON document.

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.

Properties
QStringList	availableRasterMaps
	Available Raster Maps.

QString	copyrightNotice
	Copyright notice for the map.

QString	currentRasterMap
	Current Raster Map.

QByteArray	geoJSON
	Union of all aviation maps in GeoJSON format.

QString	serverUrl
	URL under which this server is presently reachable.

QString	styleFileURL
	URL where a style file for the base map can be retrieved.

QListQSharedPointer< FileFormats::MBTILES >	terrainMapTiles
	List of terrain map MBTILES.

QList< GeoMaps::Waypoint >	waypoints
	Waypoints.

Detailed Description

Provides geographic information.

This class works closely with dataManagement/DataManager. It takes the data provided by the DataManager, and serves it for use in MapBoxGL powered maps. Additional data is served via the API.

The class ensures that the currently available base maps are served via the embedded TileServer.
The class generates a mapbox style file whose source element points to the URL of the embedded TileServer. The style file automatically adjusts when raster maps or vector maps are installed.
All available aviation data is provided in GeoJSON.
Waypoints and airspaces are accessible via the API.

Definition at line 64 of file GeoMapProvider.h.

Constructor & Destructor Documentation

◆ GeoMapProvider()

GeoMaps::GeoMapProvider::GeoMapProvider ( QObject * parent = nullptr )

explicit

Creates a new GeoMap provider.

This constructor creates a new GeoMapProvider instance.

Parameters

parent The standard QObject parent

Member Function Documentation

◆ airspaces()

Q_INVOKABLE QVariantList GeoMaps::GeoMapProvider::airspaces ( const QGeoCoordinate & position )

nodiscard

List of airspaces at a given location.

Parameters

position Position over which airspaces are searched for

Returns: all airspaces that exist over a given position. For better cooperation with QML the list returns contains elements of type QObject*, and not Airspace*.

◆ availableRasterMaps()

QStringList GeoMaps::GeoMapProvider::availableRasterMaps ( ) const

inlinenodiscard

Getter function for the property with the same name.

Returns: Property availableRasterMaps

Definition at line 170 of file GeoMapProvider.h.

◆ bindableAvailableRasterMaps()

QBindable< QStringList > GeoMaps::GeoMapProvider::bindableAvailableRasterMaps ( ) const

inlinenodiscard

Getter function for the property with the same name.

Returns: Property availableRasterMaps

Definition at line 179 of file GeoMapProvider.h.

◆ bindableCurrentRasterMap()

QBindable< QString > GeoMaps::GeoMapProvider::bindableCurrentRasterMap ( ) const

inlinenodiscard

Getter function for the property with the same name.

Returns: Property currentRasterMap

Definition at line 200 of file GeoMapProvider.h.

◆ closestWaypoint()

Q_INVOKABLE GeoMaps::Waypoint GeoMaps::GeoMapProvider::closestWaypoint	(	QGeoCoordinate	position,
		const QGeoCoordinate &	distPosition )

nodiscard

Find closest waypoint to a given position.

Parameters

position	Position near which waypoints are searched for
distPosition	Reference position

Returns: The Waypoint that is closest to the given position, provided that the distance is not bigger than that to distPosition. If no sufficiently close waypoint is found, a generic Waypoint with the appropriate coordinate is returned. The method checks waypoints from the map, and waypoints from the library.

◆ copyrightNotice()

static QString GeoMaps::GeoMapProvider::copyrightNotice ( )

staticnodiscard

Getter function for the property with the same name.

Returns: Property copyrightNotice

◆ createWaypoint()

static Q_INVOKABLE GeoMaps::Waypoint GeoMaps::GeoMapProvider::createWaypoint ( )

inlinestaticnodiscard

Create invalid waypoint.

This is a helper method for QML, where creation of waypoint objects is difficult.

Returns: An invalid waypoint

Definition at line 284 of file GeoMapProvider.h.

◆ currentRasterMap()

QString GeoMaps::GeoMapProvider::currentRasterMap ( ) const

inlinenodiscard

Getter function for the property with the same name.

Returns: Property currentRasterMap

Definition at line 194 of file GeoMapProvider.h.

◆ deferredInitialization()

void GeoMaps::GeoMapProvider::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.

◆ emptyGeoJSON()

static Q_INVOKABLE QByteArray GeoMaps::GeoMapProvider::emptyGeoJSON ( )

staticnodiscard

Create empty GeoJSON document.

Returns: Empty, but valid GeoJSON document

◆ filteredWaypoints()

Q_INVOKABLE QVector< GeoMaps::Waypoint > GeoMaps::GeoMapProvider::filteredWaypoints ( const QString & filter )

nodiscard

Waypoints containing a given substring.

Parameters

filter List of words

Returns: all those waypoints whose fullName or codeName contains each of the words in filter. The list contains both waypoints from the map, and waypoints from the library and is sorted alphabetically.

◆ findByID()

Q_INVOKABLE Waypoint GeoMaps::GeoMapProvider::findByID ( const QString & icaoID )

nodiscard

Find a waypoint by its ICAO code

Parameters

icaoID ICAO code of the waypoint, such as "EDDF" for Frankfurt

Returns: A waypoint, potentially invalid if the icaoID is unknown

◆ geoJSON()

QByteArray GeoMaps::GeoMapProvider::geoJSON ( )

nodiscard

Getter function for the property with the same name.

Returns: Property geoJSON

◆ nearbyWaypoints()

Q_INVOKABLE QList< GeoMaps::Waypoint > GeoMaps::GeoMapProvider::nearbyWaypoints	(	const QGeoCoordinate &	position,
		const QString &	type )

nodiscard

List of nearby waypoints

Parameters

position	Position near which waypoints are searched for
type	Type of waypoints (AD, NAV, WP)

Returns: a list of the 20 waypoints of requested type that are closest to the given position; the list may however be empty or contain fewer than 20 items. For better cooperation with QML the list does not contain elements of type Waypoint*, but elements of type QObject*

◆ serverUrl()

QString GeoMaps::GeoMapProvider::serverUrl ( )

inlinenodiscard

Getter function for the property with the same name.

Returns: Property serverUrl

Definition at line 212 of file GeoMapProvider.h.

◆ setCurrentRasterMap()

void GeoMaps::GeoMapProvider::setCurrentRasterMap ( const QString & mapName )

Setter function for the property with the same name.

Parameters

mapName currentRasterMap

◆ styleFileURL()

QString GeoMaps::GeoMapProvider::styleFileURL ( )

nodiscard

Getter function for the property with the same name.

Returns: Property styleFileURL

◆ terrainElevationAMSL()

Q_INVOKABLE Units::Distance GeoMaps::GeoMapProvider::terrainElevationAMSL ( const QGeoCoordinate & coordinate )

nodiscard

Elevation of terrain at a given coordinate, above sea level.

Parameters

coordinate Coordinate

Returns: Elevation of the terrain at coordinate over MSP, or NaN if the terrain elevation is unknown

◆ terrainMapTiles()

QList< QSharedPointer< FileFormats::MBTILES > > GeoMaps::GeoMapProvider::terrainMapTiles ( ) const

inlinenodiscard

Getter function for the property with the same name.

Returns: Property terrainMapTiles

Definition at line 224 of file GeoMapProvider.h.

◆ waypoints()

QList< Waypoint > GeoMaps::GeoMapProvider::waypoints ( )

nodiscard

Getter function for the property with the same name.

Returns: Property waypoints

Property Documentation

◆ availableRasterMaps

QStringList GeoMaps::GeoMapProvider::availableRasterMaps

read

Available Raster Maps.

This property holds the names of raster maps that can be set with setCurrentRasterMap.

Definition at line 104 of file GeoMapProvider.h.

◆ copyrightNotice

QString GeoMaps::GeoMapProvider::copyrightNotice

read

Copyright notice for the map.

This property holds the copyright notice for the installed aviation and base maps as a HTML string, ready to be shown to the user.

Definition at line 111 of file GeoMapProvider.h.

◆ currentRasterMap

QString GeoMaps::GeoMapProvider::currentRasterMap

readwrite

Current Raster Map.

This property holds the name of the current raster map, or an empty string if no map has been set. The raster map is exposed via the URL

GeoMapProvider.serverUrl() + "/rasterMap/"

See also: The documentation of the setter for naming conventions.

Definition at line 122 of file GeoMapProvider.h.

◆ geoJSON

QByteArray GeoMaps::GeoMapProvider::geoJSON

read

Union of all aviation maps in GeoJSON format.

This property holds all installed aviation maps in GeoJSON format, combined into one GeoJSON document.

Definition at line 129 of file GeoMapProvider.h.

◆ serverUrl

QString GeoMaps::GeoMapProvider::serverUrl

read

URL under which this server is presently reachable.

The property holds returns the Url where the server is listening to incoming connections. This is typically string of the form "http://127.0.0.1:3470". If the server is not listening to incoming connections, the string is empty.

Definition at line 137 of file GeoMapProvider.h.

◆ styleFileURL

QString GeoMaps::GeoMapProvider::styleFileURL

read

URL where a style file for the base map can be retrieved.

This property holds a URL where a mapbox style file for the base map can be retrieved. The style file is adjusted, so that its source element points to the local TileServer URL where the base map is served. Whenever the base map changes (e.g. because new maps have been downloaded or removed), the style file is deleted, a new style file is generated and a notification signal is emitted.

Definition at line 148 of file GeoMapProvider.h.

◆ waypoints

QList<GeoMaps::Waypoint> GeoMaps::GeoMapProvider::waypoints

read

Waypoints.

A list of all waypoints known to this GeoMapProvider (that is, the union of all waypoints in any of the installed maps)

Definition at line 158 of file GeoMapProvider.h.

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

/home/runner/work/enroute/enroute/src/geomaps/GeoMapProvider.h

Signals

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ GeoMapProvider()

Member Function Documentation

◆ airspaces()

◆ availableRasterMaps()

◆ bindableAvailableRasterMaps()

◆ bindableCurrentRasterMap()

◆ closestWaypoint()

◆ copyrightNotice()

◆ createWaypoint()

◆ currentRasterMap()

◆ deferredInitialization()

◆ emptyGeoJSON()

◆ filteredWaypoints()

◆ findByID()

◆ geoJSON()

◆ nearbyWaypoints()

◆ serverUrl()

◆ setCurrentRasterMap()

◆ styleFileURL()

◆ terrainElevationAMSL()

◆ terrainMapTiles()

◆ waypoints()

Property Documentation

◆ availableRasterMaps

◆ copyrightNotice

◆ currentRasterMap

◆ geoJSON

◆ serverUrl

◆ styleFileURL

◆ waypoints