Base class for global singleton objects. More...

#include <GlobalObject.h>

Inheritance diagram for GlobalObject:

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

	~GlobalObject () override=default
	Standard deconstructor.

Static Public Member Functions
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.

Protected Member Functions
virtual void	deferredInitialization ()
	Non-constructor initialization.

Detailed Description

Base class for global singleton objects.

This is the base class for static instances of classes that are used throughout the application. The instances are constructed lazily at runtime, whenever the appropriate methods are called. They are children of the QCoreApplication object and deleted along with this object.

Although all relevant methods are static, it is possible to construct an instance of this class, which allows to use this class from QML.

The static methods return pointers to application-wide static objects. They must only be called while a global QCoreApplication instance exists. If these conditions are satisfied, the pointers returned are guaranteed to be valid. The instances are owned by this class and must not be deleted. QML ownership has been set to QQmlEngine::CppOwnership.

Objects that inherit from this class MUST NOT call any of the static methods from their constructors. Instead, the method deferredInitialization() can be used, which is called immediately after the constructor returns.

The methods in this class are reentrant, but not thread safe.

Definition at line 106 of file GlobalObject.h.

Constructor & Destructor Documentation

◆ GlobalObject()

GlobalObject::GlobalObject ( QObject * parent = nullptr )

explicit

Standard constructor.

Parameters

parent The standard QObject parent pointer

◆ ~GlobalObject()

GlobalObject::~GlobalObject ( )

overridedefault

Standard deconstructor.

This destructor will destruct all application-wide static instances managed by this class.

Member Function Documentation

◆ canConstruct()

static Q_INVOKABLE bool GlobalObject::canConstruct ( )

static

Indicates if the static methods are ready to be used.

This is relevant for C++ code that is called from Android, often at unexpected times (during startup, …). This code should check that the GlobalObject class is ready before using it.

Returns: False if the app is in constructing state where the pointer-returning methods should not be used.

◆ clear()

static void GlobalObject::clear ( )

static

Deletes all globally defined objects.

This method will delete all globally defined objects in the correct order.

◆ clock()

static Q_INVOKABLE Navigation::Clock * GlobalObject::clock ( )

static

Pointer to appplication-wide static Navigation::Clock instance.

Returns: Pointer to appplication-wide static instance.

◆ dataManager()

static Q_INVOKABLE DataManagement::DataManager * GlobalObject::dataManager ( )

static

Pointer to appplication-wide static GeoMaps::DataManager instance.

Returns: Pointer to appplication-wide static instance.

◆ deferredInitialization()

virtual void GlobalObject::deferredInitialization ( )

inlineprotectedvirtual

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 in DataManagement::DataManager, GeoMaps::GeoMapProvider, Navigation::Navigator, NOTAM::NOTAMProvider, Notifications::NotificationManager, Platform::FileExchange, Platform::FileExchange, Platform::FileExchange, Platform::FileExchange, Platform::FileExchange, Platform::PlatformAdaptor, and Sensors.

Definition at line 270 of file GlobalObject.h.

◆ demoRunner()

static Q_INVOKABLE DemoRunner * GlobalObject::demoRunner ( )

static

Pointer to appplication-wide static DemoRunner instance.

Returns: Pointer to appplication-wide static instance.

◆ fileExchange()

static Q_INVOKABLE Platform::FileExchange_Abstract * GlobalObject::fileExchange ( )

static

Pointer to appplication-wide static FileExchange instance.

Returns: Pointer to appplication-wide static instance.

◆ flarmnetDB()

static Q_INVOKABLE Traffic::FlarmnetDB * GlobalObject::flarmnetDB ( )

static

Pointer to appplication-wide static FlarmnetDB instance.

Returns: Pointer to appplication-wide static instance.

◆ geoMapProvider()

static Q_INVOKABLE GeoMaps::GeoMapProvider * GlobalObject::geoMapProvider ( )

static

Pointer to appplication-wide static GeoMaps::GeoMapProvider instance.

Returns: Pointer to appplication-wide static instance.

◆ globalSettings()

static Q_INVOKABLE GlobalSettings * GlobalObject::globalSettings ( )

static

Pointer to appplication-wide static Settings instance.

Returns: Pointer to appplication-wide static instance.

◆ librarian()

static Q_INVOKABLE Librarian * GlobalObject::librarian ( )

static

Pointer to appplication-wide static librarian instance.

Returns: Pointer to appplication-wide static instance.

◆ navigator()

static Q_INVOKABLE Navigation::Navigator * GlobalObject::navigator ( )

static

Pointer to appplication-wide static Navigation::Navigator instance.

Returns: Pointer to appplication-wide static instance.

◆ networkAccessManager()

static Q_INVOKABLE QNetworkAccessManager * GlobalObject::networkAccessManager ( )

static

Pointer to appplication-wide static QNetworkAccessManager instance.

Returns: Pointer to appplication-wide static instance.

◆ notamProvider()

static Q_INVOKABLE NOTAM::NOTAMProvider * GlobalObject::notamProvider ( )

static

Pointer to appplication-wide static notification manager instance.

Returns: Pointer to appplication-wide static instance.

◆ notificationManager()

static Q_INVOKABLE Notifications::NotificationManager * GlobalObject::notificationManager ( )

static

Pointer to appplication-wide static notification manager instance.

Returns: Pointer to appplication-wide static instance.

◆ passwordDB()

static Q_INVOKABLE Traffic::PasswordDB * GlobalObject::passwordDB ( )

static

Pointer to appplication-wide static PasswordDB instance.

Returns: Pointer to appplication-wide static instance.

◆ platformAdaptor()

static Q_INVOKABLE Platform::PlatformAdaptor_Abstract * GlobalObject::platformAdaptor ( )

static

Pointer to appplication-wide static PlatformAdaptor instance.

Returns: Pointer to appplication-wide static instance.

◆ positionProvider()

static Q_INVOKABLE Positioning::PositionProvider * GlobalObject::positionProvider ( )

static

Pointer to appplication-wide static PositionProvider instance.

Returns: Pointer to appplication-wide static instance.

◆ sensors()

static Q_INVOKABLE Sensors * GlobalObject::sensors ( )

static

Pointer to appplication-wide static Navigation::Clock instance.

Returns: Pointer to appplication-wide static instance.

◆ sslErrorHandler()

static Q_INVOKABLE DataManagement::SSLErrorHandler * GlobalObject::sslErrorHandler ( )

static

Pointer to appplication-wide static QNetworkAccessManager instance.

Returns: Pointer to appplication-wide static instance.

◆ trafficDataProvider()

static Q_INVOKABLE Traffic::TrafficDataProvider * GlobalObject::trafficDataProvider ( )

static

Pointer to appplication-wide static TrafficDataProvider instance.

Returns: Pointer to appplication-wide static instance.

◆ waypointLibrary()

static Q_INVOKABLE GeoMaps::WaypointLibrary * GlobalObject::waypointLibrary ( )

static

Pointer to appplication-wide static WaypointLibrary instance.

Returns: Pointer to appplication-wide static instance.

◆ weatherDataProvider()

static Q_INVOKABLE Weather::WeatherDataProvider * GlobalObject::weatherDataProvider ( )

static

Pointer to appplication-wide static WeatherDataProvider instance.

Returns: Pointer to appplication-wide static instance.

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

/home/runner/work/enroute/enroute/src/GlobalObject.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ GlobalObject()

◆ ~GlobalObject()

Member Function Documentation

◆ canConstruct()

◆ clear()

◆ clock()

◆ dataManager()

◆ deferredInitialization()

◆ demoRunner()

◆ fileExchange()

◆ flarmnetDB()

◆ geoMapProvider()

◆ globalSettings()

◆ librarian()

◆ navigator()

◆ networkAccessManager()

◆ notamProvider()

◆ notificationManager()

◆ passwordDB()

◆ platformAdaptor()

◆ positionProvider()

◆ sensors()

◆ sslErrorHandler()

◆ trafficDataProvider()

◆ waypointLibrary()

◆ weatherDataProvider()