Interface to platform-specific functionality. More...

#include <PlatformAdaptor_Abstract.h>

Inheritance diagram for Platform::PlatformAdaptor_Abstract:

Public Slots
virtual void	onGUISetupCompleted ()
	Signal handler: GUI setup completed.

Signals
void	error (const QString &message)
	Emitted when an error occurs.

void	languageChanged ()
	Emitted when the OS requests a language change.

void	wifiConnected ()
	Emitted when a new WiFi connections becomes available.

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

virtual Q_INVOKABLE QString	currentSSID ()
	SSID of current Wi-Fi network.

virtual Q_INVOKABLE void	disableScreenSaver ()
	Disable the screen saver.

virtual Q_INVOKABLE void	lockWifi (bool lock)
	Lock connection to Wi-Fi network.

virtual Q_INVOKABLE void	openSatView (const QGeoCoordinate &coordinate)
	Open an external app or web site showing a satellite view.

virtual Q_INVOKABLE void	setupInputMethodEventFilter (QQuickItem *item)
	Workaround for QTBUG-80790.

virtual Q_INVOKABLE QString	systemInfo ()
	Information about the system, in HTML format.

virtual Q_INVOKABLE void	vibrateBrief ()
	Make the device briefly vibrate.

virtual Q_INVOKABLE void	vibrateLong ()
	Make the device vibrate for a longer period.

virtual Q_INVOKABLE QString	language ()
	Language code that is to be used in the GUI.

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

	~GlobalObject () override=default
	Standard deconstructor.

Static Public Member Functions
static Q_INVOKABLE QString	clipboardText ()
	Content of ClipBoard.

static Q_INVOKABLE void	saveScreenshot (const QImage &image, const QString &path)
	Save image as a raster graphic file in path.

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.

Additional Inherited Members
Protected Member Functions inherited from GlobalObject
virtual void	deferredInitialization ()
	Non-constructor initialization.

Detailed Description

Interface to platform-specific functionality.

This pure virtual class is an interface to capabilities of mobile devices (e.g. vibration) that need platform-specific code to operate. The files PlatformAdaptor_XXX.(h|cpp) implement a child class PlatformAdaptor that contains the actual implementation.

Child classes need to implement all pure virtual functions, and need to provide the following additional functionality.

Child classes need to monitor the Wi-Fi network and emit the signal wifiConnected() whenever a new Wi-Fi connection becomes available. The app will then check if a traffic data receiver is active in the network.
If supported by the platform, child classes need to react to requests by the platform to open a file (e.g. a GeoJSON file containing a flight route). Once a request is received, the method processFileRequest() should be called.

Definition at line 52 of file PlatformAdaptor_Abstract.h.

Constructor & Destructor Documentation

◆ PlatformAdaptor_Abstract()

Platform::PlatformAdaptor_Abstract::PlatformAdaptor_Abstract ( QObject * parent = nullptr )

explicit

Standard constructor.

Parameters

parent Standard QObject parent pointer

Member Function Documentation

◆ clipboardText()

static Q_INVOKABLE QString Platform::PlatformAdaptor_Abstract::clipboardText ( )

static

Content of ClipBoard.

Returns: Text content of the clipboard

◆ currentSSID()

virtual Q_INVOKABLE QString Platform::PlatformAdaptor_Abstract::currentSSID ( )

inlinevirtual

SSID of current Wi-Fi network.

Returns: The SSID of the current Wi-Fi networks, an empty string if the device is not connected to a Wi-Fi or a generic string if the SSID cannot be determined.

Reimplemented in Platform::PlatformAdaptor, Platform::PlatformAdaptor, Platform::PlatformAdaptor, Platform::PlatformAdaptor, and Platform::PlatformAdaptor.

Definition at line 93 of file PlatformAdaptor_Abstract.h.

◆ disableScreenSaver()

virtual Q_INVOKABLE void Platform::PlatformAdaptor_Abstract::disableScreenSaver ( )

inlinevirtual

Disable the screen saver.

On platforms that support this, this method shall disable to screen saver, so that the display does not switch off automatically. This is meant to ensure that the display remains on while the app is in use (e.g. while the pilot is following a non-standard traffic pattern).

Reimplemented in Platform::PlatformAdaptor, Platform::PlatformAdaptor, Platform::PlatformAdaptor, Platform::PlatformAdaptor, and Platform::PlatformAdaptor.

Definition at line 102 of file PlatformAdaptor_Abstract.h.

◆ error

void Platform::PlatformAdaptor_Abstract::error ( const QString & message )

signal

Emitted when an error occurs.

This signal is emitted when an error occurs. The GUI will show the message in an appropriate dialog.

Parameters

message Human-readable, translated message

◆ language()

virtual Q_INVOKABLE QString Platform::PlatformAdaptor_Abstract::language ( )

virtual

Language code that is to be used in the GUI.

Returns: A two-letter language code (such as "en" or "de") that describes the language that is to be used in the GUI.

Reimplemented in Platform::PlatformAdaptor.

◆ languageChanged

void Platform::PlatformAdaptor_Abstract::languageChanged ( )

signal

Emitted when the OS requests a language change.

This signal is emitted when the OS requests a language change. The GUI will show a dialog requesting the user to restart the app.

◆ lockWifi()

virtual Q_INVOKABLE void Platform::PlatformAdaptor_Abstract::lockWifi ( bool lock )

inlinevirtual

Lock connection to Wi-Fi network.

If supported by the platform, this method is supposed to lock the current Wi-Fi connection, that is, to prevent the device from dropping the connection or shutting down the Wi-Fi interface.

The app calls that method after connecting to a traffic data receiver, in order to ensure that traffic data is continuously received.

Parameters

lock	If true, then lock the network. If false, then release the lock.

Reimplemented in Platform::PlatformAdaptor, Platform::PlatformAdaptor, Platform::PlatformAdaptor, and Platform::PlatformAdaptor.

Definition at line 116 of file PlatformAdaptor_Abstract.h.

◆ onGUISetupCompleted

virtual void Platform::PlatformAdaptor_Abstract::onGUISetupCompleted ( )

inlinevirtualslot

Signal handler: GUI setup completed.

This method is called as soon as the GUI setup is completed. On Android, this method is used to hide the splash screen and to show the app.

The implementation should guarentee that nothing bad happens if the method is called more than once.

Reimplemented in Platform::PlatformAdaptor, Platform::PlatformAdaptor, Platform::PlatformAdaptor, Platform::PlatformAdaptor, and Platform::PlatformAdaptor.

Definition at line 191 of file PlatformAdaptor_Abstract.h.

◆ openSatView()

virtual Q_INVOKABLE void Platform::PlatformAdaptor_Abstract::openSatView ( const QGeoCoordinate & coordinate )

virtual

Open an external app or web site showing a satellite view.

This implementation uses QDesktopServices::openUrl() to open the location in Google Maps, either in a native app or in an external web browser winde. The Android implementation tries Google Earth first and falls back to Google Maps if Google Earth is not installed.

Parameters

coordinate Location whose sat view should be shown.

Reimplemented in Platform::PlatformAdaptor.

◆ saveScreenshot()

static Q_INVOKABLE void Platform::PlatformAdaptor_Abstract::saveScreenshot	(	const QImage &	image,
		const QString &	path )

static

Save image as a raster graphic file in path.

The image file type (PNG, JPG, …) is inferred from the file path

Parameters

image	Image to be saved.
path	File path where the image will be stored

◆ setupInputMethodEventFilter()

virtual Q_INVOKABLE void Platform::PlatformAdaptor_Abstract::setupInputMethodEventFilter ( QQuickItem * item )

inlinevirtual

Workaround for QTBUG-80790.

This method is empty except on iOS, where it installs a special event filter for a QQuickItem. The event filter avoids problematic behavior where the virtual keyboard pushes up the whole qml page. Details for this problem and the present workaround are described here.

https://stackoverflow.com/questions/34716462/ios-sometimes-keyboard-pushes-up-the-whole-qml-page

https://bugreports.qt.io/browse/QTBUG-80790

Parameters

item	QQuickItem where the event filter is to be intalled.

Reimplemented in Platform::PlatformAdaptor.

Definition at line 142 of file PlatformAdaptor_Abstract.h.

◆ systemInfo()

virtual Q_INVOKABLE QString Platform::PlatformAdaptor_Abstract::systemInfo ( )

virtual

Information about the system, in HTML format.

Returns: Info string

Reimplemented in Platform::PlatformAdaptor.

◆ vibrateBrief()

virtual Q_INVOKABLE void Platform::PlatformAdaptor_Abstract::vibrateBrief ( )

inlinevirtual

Make the device briefly vibrate.

On platforms that support this, make the device briefly vibrate if haptic feedback is enabled in the system settings.

Reimplemented in Platform::PlatformAdaptor, Platform::PlatformAdaptor, Platform::PlatformAdaptor, Platform::PlatformAdaptor, and Platform::PlatformAdaptor.

Definition at line 155 of file PlatformAdaptor_Abstract.h.

◆ vibrateLong()

virtual Q_INVOKABLE void Platform::PlatformAdaptor_Abstract::vibrateLong ( )

inlinevirtual

Make the device vibrate for a longer period.

On platforms that support this, make the device vibrate for a longer time, if haptic feedback is enabled in the system settings. This is used to when showing notifications.

Reimplemented in Platform::PlatformAdaptor, Platform::PlatformAdaptor, and Platform::PlatformAdaptor.

Definition at line 163 of file PlatformAdaptor_Abstract.h.

◆ wifiConnected

void Platform::PlatformAdaptor_Abstract::wifiConnected ( )

signal

Emitted when a new WiFi connections becomes available.

This signal is emitted when a new WiFi connection becomes available.

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

/home/runner/work/enroute/enroute/src/platform/PlatformAdaptor_Abstract.h

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PlatformAdaptor_Abstract()

Member Function Documentation

◆ clipboardText()

◆ currentSSID()

◆ disableScreenSaver()

◆ error

◆ language()

◆ languageChanged

◆ lockWifi()

◆ onGUISetupCompleted

◆ openSatView()

◆ saveScreenshot()

◆ setupInputMethodEventFilter()

◆ systemInfo()

◆ vibrateBrief()

◆ vibrateLong()

◆ wifiConnected