Intended flight route. More...

#include <FlightRoute.h>

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

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

Public Member Functions
	FlightRoute (QObject *parent=nullptr)
	Construct a flight route.

auto	boundingRectangle () const -> QGeoRectangle
	Getter function for the property with the same name.

QList< QGeoCoordinate >	geoPath () const
	Getter function for the property with the same name.

auto	midFieldWaypoints () const -> QList< GeoMaps::Waypoint >
	Getter function for the property with the same name.

auto	legs () const -> QList< Navigation::Leg >
	Getter function for the property with the same name.

auto	size () const -> qsizetype
	Getter function for the property with the same name.

auto	summary () const -> QString
	Getter function for the property with the same name.

auto	waypoints () const -> QList< GeoMaps::Waypoint >
	Getter function for the property with the same name.

Q_INVOKABLE void	append (const GeoMaps::Waypoint &waypoint)
	Adds a waypoint to the end of the route.

Q_INVOKABLE void	append (const QGeoCoordinate &position)
	Adds a waypoint to the end of the route.

Q_INVOKABLE bool	canAppend (const GeoMaps::Waypoint &other) const
	Checks if waypoint can be added as the new end of this route.

Q_INVOKABLE bool	canInsert (const GeoMaps::Waypoint &other) const
	Checks if waypoint can reasonably be inserted into this route.

Q_INVOKABLE void	clear ()
	Deletes all waypoints in the current route.

Q_INVOKABLE bool	contains (const GeoMaps::Waypoint &waypoint) const
	Returns true if waypoint is in this route.

Q_INVOKABLE void	insert (const GeoMaps::Waypoint &waypoint)
	Inserts a waypoint into the route.

Q_INVOKABLE qsizetype	lastIndexOf (const GeoMaps::Waypoint &waypoint) const
	Index for last occurrence of the waypoint in the flight route.

Q_INVOKABLE QString	load (const QString &fileName)
	Loads the route from a GeoJSON or GPX document.

Q_INVOKABLE void	moveDown (int idx)
	Move waypoint one position down in the list of waypoints.

Q_INVOKABLE void	moveUp (int idx)
	Move waypoint one position up in the list of waypoints.

Q_INVOKABLE void	removeWaypoint (int idx)
	Remove waypoint from the current route.

Q_INVOKABLE void	replaceWaypoint (int idx, const GeoMaps::Waypoint &newWaypoint)
	Replaces a waypoint.

Q_INVOKABLE void	reverse ()
	Reverse the route.

Q_INVOKABLE QString	save (const QString &fileName=QString()) const
	Saves flight route to a file.

Q_INVOKABLE QString	suggestedFilename () const
	Suggests a name for saving this route.

Q_INVOKABLE QByteArray	toGeoJSON () const
	Exports to route to GeoJSON.

Q_INVOKABLE QByteArray	toGpx () const
	Exports to route to GPX.

Properties
QGeoRectangle	boundingRectangle
	Bounding rectangle.

QList< QGeoCoordinate >	geoPath
	List of coordinates for the waypoints.

QList< GeoMaps::Waypoint >	midFieldWaypoints
	List of waypoints in the flight route that are not airfields.

QList< Navigation::Leg >	legs
	List of legs.

qsizetype	size
	Number of waypoints in the route.

QString	summary
	Human-readable summary of the flight route.

QList< GeoMaps::Waypoint >	waypoints
	List of waypoints in the flight route that are not airfields.

Detailed Description

Intended flight route.

This class represents an intended flight route. In essence, this class is little more than a list of waypoint and a number of methods that do the following.

Expose the list of waypoints and legs to QML and allow some manipulation from there, such as adding or re-arranging waypoints.
Compute length and true course for the legs in the flight path, as well as a total length and expose this data to QML.

Definition at line 59 of file FlightRoute.h.

Constructor & Destructor Documentation

◆ FlightRoute()

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

explicit

Construct a flight route.

This default constructor calls load(), restoring the last saved route. The route is saved to a standard location whenever it changes, so that the route survives when the app is closed unexpectantly.

Parameters

parent The standard QObject parent pointer.

Member Function Documentation

◆ append() [1/2]

Q_INVOKABLE void Navigation::FlightRoute::append ( const GeoMaps::Waypoint & waypoint )

Adds a waypoint to the end of the route.

Parameters

waypoint Waypoint to be added

◆ append() [2/2]

Q_INVOKABLE void Navigation::FlightRoute::append ( const QGeoCoordinate & position )

Adds a waypoint to the end of the route.

This method generates a generic waypoint with the given coordinates.

Parameters

position Coordinates of the waypoint.

◆ boundingRectangle()

auto Navigation::FlightRoute::boundingRectangle ( ) const -> QGeoRectangle

nodiscard

Getter function for the property with the same name.

Returns: Property boundingRectangle

◆ canAppend()

Q_INVOKABLE bool Navigation::FlightRoute::canAppend ( const GeoMaps::Waypoint & other ) const

nodiscard

Checks if waypoint can be added as the new end of this route.

Parameters

other Waypoint to be appended

Returns: True if route is empty or if other waypoint is not near the current end of the route.

◆ canInsert()

Q_INVOKABLE bool Navigation::FlightRoute::canInsert ( const GeoMaps::Waypoint & other ) const

nodiscard

Checks if waypoint can reasonably be inserted into this route.

Parameters

other Waypoint to be inserted

Returns: True if it makes sense to insert the waypoint.

◆ contains()

Q_INVOKABLE bool Navigation::FlightRoute::contains ( const GeoMaps::Waypoint & waypoint ) const

nodiscard

Returns true if waypoint is in this route.

Parameters

waypoint Waypoint

Returns: bool Returns true if waypoint geographically close to a waypoint in the route

◆ geoPath()

QList< QGeoCoordinate > Navigation::FlightRoute::geoPath ( ) const

inlinenodiscard

Getter function for the property with the same name.

Returns: Property geoPath

Definition at line 148 of file FlightRoute.h.

◆ insert()

Q_INVOKABLE void Navigation::FlightRoute::insert ( const GeoMaps::Waypoint & waypoint )

Inserts a waypoint into the route.

Inserts the waypoint into the route, at the place that minimizes the overall route length. If canInsert() is false, this method does nothing.

Parameters

waypoint Waypoint to be inserted.

◆ lastIndexOf()

Q_INVOKABLE qsizetype Navigation::FlightRoute::lastIndexOf ( const GeoMaps::Waypoint & waypoint ) const

nodiscard

Index for last occurrence of the waypoint in the flight route.

This method finds the index position of the last waypoint in the route that is geograhphically close to the given waypoint.

Parameters

waypoint Waypoint to be searched

Returns: Index position of the last waypoint in the route close to the given waypoint. Returns -1 if no waypoint is close.

◆ legs()

auto Navigation::FlightRoute::legs ( ) const -> QList<Navigation::Leg>

inlinenodiscard

Getter function for the property with the same name.

Returns: Property legs

Definition at line 161 of file FlightRoute.h.

◆ load()

Q_INVOKABLE QString Navigation::FlightRoute::load ( const QString & fileName )

Loads the route from a GeoJSON or GPX document.

This method loads the flight route from a GeoJSON or GPX file. The method detects waypoints (such as airfields) by looking at the coordinates.

Parameters

fileName File name, needs to include path and extension. URLs of the form "file://path" are accepted. Under Android, content URLs are also accepted.

Returns: Empty string in case of success, human-readable, translated error message otherwise.

◆ midFieldWaypoints()

auto Navigation::FlightRoute::midFieldWaypoints ( ) const -> QList< GeoMaps::Waypoint >

nodiscard

Getter function for the property with the same name.

Returns: Property midFieldWaypoints

◆ moveDown()

Q_INVOKABLE void Navigation::FlightRoute::moveDown ( int idx )

Move waypoint one position down in the list of waypoints.

Parameters

idx	Index of the waypoint

◆ moveUp()

Q_INVOKABLE void Navigation::FlightRoute::moveUp ( int idx )

Move waypoint one position up in the list of waypoints.

Parameters

idx	Index of the waypoint

◆ removeWaypoint()

Q_INVOKABLE void Navigation::FlightRoute::removeWaypoint ( int idx )

Remove waypoint from the current route.

If the waypoint is contained in the route, the method returns immediately.

Parameters

idx	Index of the waypoint

◆ replaceWaypoint()

Q_INVOKABLE void Navigation::FlightRoute::replaceWaypoint	(	int	idx,
		const GeoMaps::Waypoint &	newWaypoint )

Replaces a waypoint.

Replaces the waypoint with the given index. If the index is invalid if the new waypoint equals the old one, then this method does nothing. The signal "waypoint changed" is emitted as appropriate.

Parameters

idx	Index of waypoint
newWaypoint	New waypoint

◆ save()

Q_INVOKABLE QString Navigation::FlightRoute::save ( const QString & fileName = QString() ) const

nodiscard

Saves flight route to a file.

This method saves the flight route as a GeoJSON file. The file conforms to the specification outlined here.

Parameters

fileName File name, needs to include path and extension

Returns: Empty string in case of success, human-readable, translated error message otherwise.

◆ size()

auto Navigation::FlightRoute::size ( ) const -> qsizetype

inlinenodiscard

Getter function for the property with the same name.

Returns: Property size

Definition at line 167 of file FlightRoute.h.

◆ suggestedFilename()

Q_INVOKABLE QString Navigation::FlightRoute::suggestedFilename ( ) const

nodiscard

Suggests a name for saving this route.

This method suggests a name for saving the present route (without path and file extension).

Returns: Suggested name for saving the file. If no useful suggestion can be made, the returned string is a translation of "Flight Route"

◆ summary()

auto Navigation::FlightRoute::summary ( ) const -> QString

nodiscard

Getter function for the property with the same name.

Returns: Property summary

◆ toGeoJSON()

Q_INVOKABLE QByteArray Navigation::FlightRoute::toGeoJSON ( ) const

nodiscard

Exports to route to GeoJSON.

This method serialises the current flight route as a GeoJSON document. The document conforms to the specification outlined here.

Returns: QByteArray describing the flight route

◆ toGpx()

Q_INVOKABLE QByteArray Navigation::FlightRoute::toGpx ( ) const

nodiscard

Exports to route to GPX.

This method serialises the current flight route as a GPX document. The document conforms to the specification outlined here

Returns: QByteArray containing GPX data describing the flight route

◆ waypoints()

auto Navigation::FlightRoute::waypoints ( ) const -> QList<GeoMaps::Waypoint>

inlinenodiscard

Getter function for the property with the same name.

Returns: Property waypoints

Definition at line 179 of file FlightRoute.h.

Property Documentation

◆ boundingRectangle

QGeoRectangle Navigation::FlightRoute::boundingRectangle

read

Bounding rectangle.

This is a QGeoRectangle that contains the route. The rectangle might be invalid, for instance if the route is empty.

Definition at line 91 of file FlightRoute.h.

◆ geoPath

QList<QGeoCoordinate> Navigation::FlightRoute::geoPath

read

List of coordinates for the waypoints.

This property holds a list of coordinates of the waypoints, suitable for drawing the flight path on a QML map.

Definition at line 98 of file FlightRoute.h.

◆ legs

QList<Navigation::Leg> Navigation::FlightRoute::legs

read

List of legs.

This property returns a list of all legs in the route.

Definition at line 111 of file FlightRoute.h.

◆ midFieldWaypoints

QList<GeoMaps::Waypoint> Navigation::FlightRoute::midFieldWaypoints

read

List of waypoints in the flight route that are not airfields.

This property lists all the waypoints in the route that are not airfields, navaids, reporting points, etc.

Definition at line 105 of file FlightRoute.h.

◆ summary

QString Navigation::FlightRoute::summary

read

Human-readable summary of the flight route.

This is a string of the form "48 nm · 0:28 h · 1,9 gal", potentially with HTML complaints if wind or aircraft data was missing.

The summary is computed for the aircraft and wind that are presently set in the global Navigator class.

Definition at line 124 of file FlightRoute.h.

◆ waypoints

QList<GeoMaps::Waypoint> Navigation::FlightRoute::waypoints

read

List of waypoints in the flight route that are not airfields.

This property lists all the waypoints in the route that are not airfields, navaids, reporting points, etc.

Definition at line 131 of file FlightRoute.h.

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

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

Signals

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ FlightRoute()

Member Function Documentation

◆ append() [1/2]

◆ append() [2/2]

◆ boundingRectangle()

◆ canAppend()

◆ canInsert()

◆ contains()

◆ geoPath()

◆ insert()

◆ lastIndexOf()

◆ legs()

◆ load()

◆ midFieldWaypoints()

◆ moveDown()

◆ moveUp()

◆ removeWaypoint()

◆ replaceWaypoint()

◆ save()

◆ size()

◆ suggestedFilename()

◆ summary()

◆ toGeoJSON()

◆ toGpx()

◆ waypoints()

Property Documentation

◆ boundingRectangle

◆ geoPath

◆ legs

◆ midFieldWaypoints

◆ summary

◆ waypoints