Manages the list of geographic maps. More...

#include <DataManager.h>

Inheritance diagram for DataManagement::DataManager:

Public Slots
void	updateRemoteDataItemListIfOutdated ()
	Triggers an update of the list of remotely available data items.

Signals
void	appUpdateRequiredChanged ()

void	error (const QString &message)
	Error message for user.

void	whatsNewChanged ()
	Notifier signal.

Public Member Functions
	DataManager (QObject *parent=nullptr)
	Standard constructor.

void	deferredInitialization () override
	Non-constructor initialization.

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

DataManagement::Downloadable_MultiFile *	aviationMaps ()
	Getter function for the property with the same name.

DataManagement::Downloadable_MultiFile *	baseMaps ()
	Getter function for the property with the same name.

DataManagement::Downloadable_MultiFile *	baseMapsRaster ()
	Getter function for the property with the same name.

DataManagement::Downloadable_MultiFile *	baseMapsVector ()
	Getter function for the property with the same name.

DataManagement::Downloadable_MultiFile *	databases ()
	Getter function for the property with the same name.

DataManagement::Downloadable_MultiFile *	items ()
	Getter function for the property with the same name.

DataManagement::Downloadable_SingleFile *	mapList ()
	Getter function for the property with the same name.

DataManagement::Downloadable_MultiFile *	mapsAndData ()
	Getter function for the property with the same name.

DataManagement::Downloadable_MultiFile *	mapSets ()
	Getter function for the property with the same name.

DataManagement::Downloadable_MultiFile *	terrainMaps ()
	Getter function for the property with the same name.

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

Units::ByteSize	whatsNewHash () const
	Getter function for the property with the same name.

Q_INVOKABLE QString	import (const QString &fileName, const QString &newName)
	Import raster or vector map into the library of locally installed maps.

Q_INVOKABLE QString	importOpenAir (const QString &fileName, const QString &newName)
	Import airspace data into the library of locally installed maps.

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

	~GlobalObject () override=default
	Standard deconstructor.

Properties
bool	appUpdateRequired
	Indiates that the app needs to be updated.

DataManagement::Downloadable_MultiFile *	aviationMaps
	Downloadable_MultiFile that holds all aviation maps.

DataManagement::Downloadable_MultiFile *	baseMapsRaster
	Downloadable_MultiFile that holds all base maps in raster format.

DataManagement::Downloadable_MultiFile *	baseMapsVector
	Downloadable_MultiFile that holds all base maps in vector format.

DataManagement::Downloadable_MultiFile *	baseMaps
	Downloadable_MultiFile that holds all base maps.

DataManagement::Downloadable_MultiFile *	databases
	Downloadable_MultiFile that holds all databases.

DataManagement::Downloadable_MultiFile *	items
	Downloadable_MultiFile that holds all data items.

DataManagement::Downloadable_SingleFile *	mapList
	Downloadable_SingleFile that holds the list of all maps and databases.

DataManagement::Downloadable_MultiFile *	mapsAndData
	Downloadable_MultiFile that holds all the map sets and databases.

DataManagement::Downloadable_MultiFile *	mapSets
	Downloadable_MultiFile that holds all map sets.

DataManagement::Downloadable_MultiFile *	terrainMaps
	Downloadable_MultiFile that holds all terrain maps.

QString	whatsNew
	Current "what's new" message.

Units::ByteSize	whatsNewHash
	Hash of the current "what's new" message.

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

Manages the list of geographic maps.

This class manages a list of remotely available and locally installed databases and geographic maps. More specifically, it manages the following items.

Aviation maps (in GeoJSON format, file name ends in "geojson")
Base maps/raster (in MBTILES format, file name ends in "mbtiles")
Base maps/vector (in MBTILES format, file name ends in "raster")
Terrain maps (in MBTILES format, file name ends in "terrain")
FLARM Databases (as a text file, file name ends in "data")

In addition, it allows access to the following data.

"What's new"-message from remove server

The class retrieves the list of available items from a remote server on a regular basis, updates the list automatically once a week, and maintains a list of Downloadable objects that corresponds to the remotely available and locally installed items.

The address of the remote server is hardcoded into the binary. The list is downloaded to a file "maps.json" in QStandardPaths::writableLocation(QStandardPaths::AppDataLocation). The format of the file is described at this URL:

https://github.com/Akaflieg-Freiburg/enrouteServer/wiki/The-file-maps.json

Locally installed items are saved in the directory "aviation_maps" in QStandardPaths::writableLocation(QStandardPaths::AppDataLocation), or into a suitable subdirectory of this.

The implementation assumes that no other program interferes with the file "maps.json" and with the directory "aviation_maps".

Definition at line 70 of file DataManager.h.

Constructor & Destructor Documentation

◆ DataManager()

DataManagement::DataManager::DataManager ( QObject * parent = nullptr )

explicit

Standard constructor.

This constructor reads the file "maps.json" and initiates a download of the file if no file is available or if the last download is more than one week old.

Parameters

parent The standard QObject parent pointer.

Member Function Documentation

◆ appUpdateRequired()

bool DataManagement::DataManager::appUpdateRequired ( ) const

inlinenodiscard

Getter function for the property with the same name.

Returns: Property aviationMaps

Definition at line 186 of file DataManager.h.

◆ appUpdateRequiredChanged

void DataManagement::DataManager::appUpdateRequiredChanged ( )

signal

Notifier signal

◆ aviationMaps()

DataManagement::Downloadable_MultiFile * DataManagement::DataManager::aviationMaps ( )

inlinenodiscard

Getter function for the property with the same name.

Returns: Property aviationMaps

Definition at line 192 of file DataManager.h.

◆ baseMaps()

DataManagement::Downloadable_MultiFile * DataManagement::DataManager::baseMaps ( )

inlinenodiscard

Getter function for the property with the same name.

Returns: Property baseMaps

Definition at line 198 of file DataManager.h.

◆ baseMapsRaster()

DataManagement::Downloadable_MultiFile * DataManagement::DataManager::baseMapsRaster ( )

inlinenodiscard

Getter function for the property with the same name.

Returns: Property baseMapsRaster

Definition at line 204 of file DataManager.h.

◆ baseMapsVector()

DataManagement::Downloadable_MultiFile * DataManagement::DataManager::baseMapsVector ( )

inlinenodiscard

Getter function for the property with the same name.

Returns: Property baseMapsVector

Definition at line 210 of file DataManager.h.

◆ databases()

DataManagement::Downloadable_MultiFile * DataManagement::DataManager::databases ( )

inlinenodiscard

Getter function for the property with the same name.

Returns: Property databases

Definition at line 216 of file DataManager.h.

◆ deferredInitialization()

void DataManagement::DataManager::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.

◆ error

void DataManagement::DataManager::error ( const QString & message )

signal

Error message for user.

This signal is emitted if an error occurs and the GUI should display a prominent error message. This signal can be emitted anytime.

Parameters

message A brief, human-readable, translated error message.

◆ import()

Q_INVOKABLE QString DataManagement::DataManager::import	(	const QString &	fileName,
		const QString &	newName )

Import raster or vector map into the library of locally installed maps.

This method imports a raster or vector map in MBTILES format into the library of locally installed maps. To avoid clashes and inconsistencies, the map will delete all locally install vector maps when importing a raster map, and all raster maps when importing a vector map.

Parameters

fileName	File name of locally raster or vector map, in MBTILES format.
newName	Name under which the map is available in the library. If the name exists, the library entry will be replaced.

Returns: A human-readable HTML string on error, or an empty string on success

◆ importOpenAir()

Q_INVOKABLE QString DataManagement::DataManager::importOpenAir	(	const QString &	fileName,
		const QString &	newName )

Import airspace data into the library of locally installed maps.

This method imports airspace data in OpenAir format into the library of locally installed maps.

Parameters

fileName	File name of locally raster or vector map, in OpenAir format.
newName	Name under which the map is available in the library. If the name exists, the library entry will be replaced.

Returns: A human-readable HTML string on error, or an empty string on success

◆ items()

DataManagement::Downloadable_MultiFile * DataManagement::DataManager::items ( )

inlinenodiscard

Getter function for the property with the same name.

Returns: Property items

Definition at line 222 of file DataManager.h.

◆ mapList()

DataManagement::Downloadable_SingleFile * DataManagement::DataManager::mapList ( )

inlinenodiscard

Getter function for the property with the same name.

Returns: Property mapsList

Definition at line 228 of file DataManager.h.

◆ mapsAndData()

DataManagement::Downloadable_MultiFile * DataManagement::DataManager::mapsAndData ( )

inlinenodiscard

Getter function for the property with the same name.

Returns: Property mapsAndData

Definition at line 234 of file DataManager.h.

◆ mapSets()

DataManagement::Downloadable_MultiFile * DataManagement::DataManager::mapSets ( )

inlinenodiscard

Getter function for the property with the same name.

Returns: Property mapSets

Definition at line 240 of file DataManager.h.

◆ terrainMaps()

DataManagement::Downloadable_MultiFile * DataManagement::DataManager::terrainMaps ( )

inlinenodiscard

Getter function for the property with the same name.

Returns: Property terrainMaps

Definition at line 246 of file DataManager.h.

◆ updateRemoteDataItemListIfOutdated

void DataManagement::DataManager::updateRemoteDataItemListIfOutdated ( )

slot

Triggers an update of the list of remotely available data items.

This will trigger a download the file maps.json from the remote server if the last update is more than one day ago.

◆ whatsNew()

QString DataManagement::DataManager::whatsNew ( ) const

inlinenodiscard

Getter function for the property with the same name.

Returns: Property whatsNew

Definition at line 252 of file DataManager.h.

◆ whatsNewHash()

Units::ByteSize DataManagement::DataManager::whatsNewHash ( ) const

inlinenodiscard

Getter function for the property with the same name.

Returns: Property lastWhatsNewHash

Definition at line 258 of file DataManager.h.

Property Documentation

◆ appUpdateRequired

bool DataManagement::DataManager::appUpdateRequired

read

Indiates that the app needs to be updated.

This property indicates that this version of the app is too old and cannot interpret maps and data that reside on the server. If this is the case, the GUI should yell at the user and block any attempt to download or update maps and data.

Definition at line 114 of file DataManager.h.

◆ aviationMaps

DataManagement::Downloadable_MultiFile* DataManagement::DataManager::aviationMaps

read

Downloadable_MultiFile that holds all aviation maps.

Pointer to a Downloadable_MultiFile that holds all aviation maps.

Definition at line 120 of file DataManager.h.

◆ baseMaps

DataManagement::Downloadable_MultiFile* DataManagement::DataManager::baseMaps

read

Downloadable_MultiFile that holds all base maps.

Pointer to a Downloadable_MultiFile that holds all base maps.

Definition at line 138 of file DataManager.h.

◆ baseMapsRaster

DataManagement::Downloadable_MultiFile* DataManagement::DataManager::baseMapsRaster

read

Downloadable_MultiFile that holds all base maps in raster format.

Pointer to a Downloadable_MultiFile that holds all base maps in raster format.

Definition at line 126 of file DataManager.h.

◆ baseMapsVector

DataManagement::Downloadable_MultiFile* DataManagement::DataManager::baseMapsVector

read

Downloadable_MultiFile that holds all base maps in vector format.

Pointer to a Downloadable_MultiFile that holds all base maps in vector format.

Definition at line 132 of file DataManager.h.

◆ databases

DataManagement::Downloadable_MultiFile* DataManagement::DataManager::databases

read

Downloadable_MultiFile that holds all databases.

Pointer to a Downloadable_MultiFile that holds all databases.

Definition at line 144 of file DataManager.h.

◆ items

DataManagement::Downloadable_MultiFile* DataManagement::DataManager::items

read

Downloadable_MultiFile that holds all data items.

Pointer to a Downloadable_MultiFile that holds all data items. This includes aviation maps, base maps, and databases.

Definition at line 151 of file DataManager.h.

◆ mapSets

DataManagement::Downloadable_MultiFile* DataManagement::DataManager::mapSets

read

Downloadable_MultiFile that holds all map sets.

Pointer to a Downloadable_MultiFile that holds all map sets.

Definition at line 163 of file DataManager.h.

◆ terrainMaps

DataManagement::Downloadable_MultiFile* DataManagement::DataManager::terrainMaps

read

Downloadable_MultiFile that holds all terrain maps.

Pointer to a Downloadable_MultiFile that holds all terrain maps.

Definition at line 169 of file DataManager.h.

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

/home/runner/work/enroute/enroute/src/dataManagement/DataManager.h

Public Slots

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DataManager()

Member Function Documentation

◆ appUpdateRequired()

◆ appUpdateRequiredChanged

◆ aviationMaps()

◆ baseMaps()

◆ baseMapsRaster()

◆ baseMapsVector()

◆ databases()

◆ deferredInitialization()

◆ error

◆ import()

◆ importOpenAir()

◆ items()

◆ mapList()

◆ mapsAndData()

◆ mapSets()

◆ terrainMaps()

◆ updateRemoteDataItemListIfOutdated

◆ whatsNew()

◆ whatsNewHash()

Property Documentation

◆ appUpdateRequired

◆ aviationMaps

◆ baseMaps

◆ baseMapsRaster

◆ baseMapsVector

◆ databases

◆ items

◆ mapSets

◆ terrainMaps