Main hub for navigation data. More...

#include <Navigator.h>

Inheritance diagram for Navigation::Navigator:

Public Types
enum	FlightStatus : quint8 { Ground , Flight , Unknown }
	FlightStatus. More...

Signals
void	aircraftChanged ()
	Notifier signal.

void	airspaceAltitudeLimitAdjusted ()
	Emitted when the airspaceAltitudeLimit is adjusted.

void	flightStatusChanged ()
	Notifier signal.

void	remainingRouteInfoChanged ()
	Notifier signal.

void	windChanged ()
	Notifier signal.

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

void	deferredInitialization () override
	Non-constructor initialization.

	~Navigator () override=default
	Standard destructor.

auto	aircraft () const -> Navigation::Aircraft
	Getter function for the property with the same name.

auto	flightRoute () -> Navigation::FlightRoute *
	Getter function for the property with the same name.

auto	flightStatus () const -> FlightStatus
	Getter function for the property with the same name.

auto	remainingRouteInfo () const -> Navigation::RemainingRouteInfo
	Getter function for the property with the same name.

auto	wind () const -> Weather::Wind
	Getter function for the property with the same name.

void	setAircraft (const Navigation::Aircraft &newAircraft)
	Setter function for property of the same name.

void	setWind (Weather::Wind newWind)
	Setter function for property of the same name.

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

	~GlobalObject () override=default
	Standard deconstructor.

Properties
Navigation::Aircraft	aircraft
	Current aircraft.

Navigation::FlightRoute *	flightRoute
	Current flight route.

FlightStatus	flightStatus
	Estimate whether the device is flying or on the ground.

Navigation::RemainingRouteInfo	remainingRouteInfo
	Up-to-date information about the remaining route.

Weather::Wind	wind
	Current wind.

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

Main hub for navigation data.

This class collects all data items that are relevant for navigation.

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

Definition at line 41 of file Navigator.h.

Member Enumeration Documentation

◆ FlightStatus

enum Navigation::Navigator::FlightStatus : quint8

FlightStatus.

Enumerator
Ground	Device is on the ground
Flight	Device is flying
Unknown	Unknown

Definition at line 49 of file Navigator.h.

Constructor & Destructor Documentation

◆ Navigator()

Navigation::Navigator::Navigator ( QObject * parent = nullptr )

explicit

Standard constructor.

Parameters

parent The standard QObject parent pointer

Member Function Documentation

◆ aircraft()

auto Navigation::Navigator::aircraft ( ) const -> Navigation::Aircraft

inlinenodiscard

Getter function for the property with the same name.

Returns: Property aircraft

Definition at line 125 of file Navigator.h.

◆ airspaceAltitudeLimitAdjusted

void Navigation::Navigator::airspaceAltitudeLimitAdjusted ( )

signal

Emitted when the airspaceAltitudeLimit is adjusted.

To ensure that all relevant airspaces are visible on the moving map, the navigator class will automatically adjust the property airspaceAltitudeLimit of the global settings object whenever (ownship true altitude + 1000ft) is higher than the present airspaceAltitudeLimit.

This signal is emitted whenever that happens.

◆ deferredInitialization()

void Navigation::Navigator::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.

◆ flightRoute()

auto Navigation::Navigator::flightRoute ( ) -> Navigation::FlightRoute *

Getter function for the property with the same name.

Returns: Property flightRoute

◆ flightStatus()

auto Navigation::Navigator::flightStatus ( ) const -> FlightStatus

inlinenodiscard

Getter function for the property with the same name.

Returns: Property flightStatus

Definition at line 137 of file Navigator.h.

◆ remainingRouteInfo()

auto Navigation::Navigator::remainingRouteInfo ( ) const -> Navigation::RemainingRouteInfo

inlinenodiscard

Getter function for the property with the same name.

Returns: Property remaining route info

Definition at line 143 of file Navigator.h.

◆ setAircraft()

void Navigation::Navigator::setAircraft ( const Navigation::Aircraft & newAircraft )

Setter function for property of the same name.

Parameters

newAircraft Property aircraft

◆ setWind()

void Navigation::Navigator::setWind ( Weather::Wind newWind )

Setter function for property of the same name.

Parameters

newWind Property wind

◆ wind()

auto Navigation::Navigator::wind ( ) const -> Weather::Wind

inlinenodiscard

Getter function for the property with the same name.

Returns: Property wind

Definition at line 149 of file Navigator.h.

Property Documentation

◆ aircraft

Navigation::Aircraft Navigation::Navigator::aircraft

readwrite

Current aircraft.

The aircraft returned here is owned by this class and must not be deleted. QML ownership has been set to QQmlEngine::CppOwnership.

Definition at line 94 of file Navigator.h.

◆ flightRoute

Navigation::FlightRoute* Navigation::Navigator::flightRoute

read

Current flight route.

This flight route returned here is owned by this class and must not be deleted. QML ownership has been set to QQmlEngine::CppOwnership.

Definition at line 101 of file Navigator.h.

◆ flightStatus

FlightStatus Navigation::Navigator::flightStatus

read

Estimate whether the device is flying or on the ground.

This property holds an estimate, as to whether the device is flying or on the ground.

Definition at line 108 of file Navigator.h.

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

/home/runner/work/enroute/enroute/src/navigation/Navigator.h

Public Types

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ FlightStatus

Constructor & Destructor Documentation

◆ Navigator()

Member Function Documentation

◆ aircraft()

◆ airspaceAltitudeLimitAdjusted

◆ deferredInitialization()

◆ flightRoute()

◆ flightStatus()

◆ remainingRouteInfo()

◆ setAircraft()

◆ setWind()

◆ wind()

Property Documentation

◆ aircraft

◆ flightRoute

◆ flightStatus