Library of user-defined waypoints. More...

#include <WaypointLibrary.h>

Inheritance diagram for GeoMaps::WaypointLibrary:

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

Public Member Functions
	WaypointLibrary (QObject *parent=nullptr)
	Creates a new waypoin library.

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

QByteArray	GeoJSON () const
	Getter function for property with the same name.

Q_INVOKABLE void	add (const GeoMaps::Waypoint &waypoint)
	Adds a waypoint to the library.

Q_INVOKABLE void	clear ()
	Clears the waypoint library.

Q_INVOKABLE bool	contains (const GeoMaps::Waypoint &waypoint) const
	Checks if library contains an given waypoint.

Q_INVOKABLE QVector< GeoMaps::Waypoint >	filteredWaypoints (const QString &filter) const
	Lists all entries in the waypoint library whose name contains the string 'filter'.

Q_INVOKABLE bool	hasNearbyEntry (const GeoMaps::Waypoint &waypoint) const
	Check if the library contains a waypoint near to a given one.

Q_INVOKABLE QString	import (const QString &fileName, bool skip)
	Import waypoints into the library.

Q_INVOKABLE QString	loadFromGeoJSON (QString fileName={})
	Read from file.

Q_INVOKABLE bool	remove (const GeoMaps::Waypoint &waypoint)
	Remove waypoint.

Q_INVOKABLE bool	replace (const GeoMaps::Waypoint &oldWaypoint, const GeoMaps::Waypoint &newWaypoint)
	Replace waypoint.

Q_INVOKABLE QString	save (QString fileName={}) const
	Save to file.

Q_INVOKABLE QByteArray	toGpx () const
	Serialize into GPX document.

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

	~GlobalObject () override=default
	Standard deconstructor.

Properties
QList< GeoMaps::Waypoint >	waypoints
	List of waypoints.

QByteArray	GeoJSON
	List of waypoints.

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.

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

Detailed Description

Library of user-defined waypoints.

This simple class that is little more than a list of waypoints, together with some auxiliary methods. The list is automatically loaded on startup, and saved every time that a change is made.

Definition at line 39 of file WaypointLibrary.h.

Constructor & Destructor Documentation

◆ WaypointLibrary()

GeoMaps::WaypointLibrary::WaypointLibrary ( QObject * parent = nullptr )

explicit

Creates a new waypoin library.

This constructor creates a new WaypointLibrary instance. The library is loaded from a GeoJSON file whose name is found in the private member stdFileName.

Parameters

parent The standard QObject parent

Member Function Documentation

◆ add()

Q_INVOKABLE void GeoMaps::WaypointLibrary::add ( const GeoMaps::Waypoint & waypoint )

Adds a waypoint to the library.

Parameters

waypoint Waypoint to be added. If that waypoint is invalid, this method will not do anything

◆ contains()

Q_INVOKABLE bool GeoMaps::WaypointLibrary::contains ( const GeoMaps::Waypoint & waypoint ) const

inlinenodiscard

Checks if library contains an given waypoint.

Parameters

waypoint Waypoint

Returns: True if an exact copy of the waypoint is found in the library

Definition at line 126 of file WaypointLibrary.h.

◆ filteredWaypoints()

Q_INVOKABLE QVector< GeoMaps::Waypoint > GeoMaps::WaypointLibrary::filteredWaypoints ( const QString & filter ) const

nodiscard

Lists all entries in the waypoint library whose name contains the string 'filter'.

The check for string containment is done in a fuzzy way.

Parameters

filter String used to filter the list

Returns: A filtered list with of waypoint, in alphabetical order

◆ GeoJSON()

QByteArray GeoMaps::WaypointLibrary::GeoJSON ( ) const

nodiscard

Getter function for property with the same name.

Returns: Property GeoJSON

◆ hasNearbyEntry()

Q_INVOKABLE bool GeoMaps::WaypointLibrary::hasNearbyEntry ( const GeoMaps::Waypoint & waypoint ) const

nodiscard

Check if the library contains a waypoint near to a given one.

The method checks proximity with the method GeoMaps::Waypoint::isNear

Parameters

waypoint Waypoint

Returns: True if yes

◆ import()

Q_INVOKABLE QString GeoMaps::WaypointLibrary::import	(	const QString &	fileName,
		bool	skip )

nodiscard

Import waypoints into the library.

This method reads waypoints from a file and adds them to the library.

Parameters

fileName	Name of file to import. Must be in CUP, GPX or GeoJSON format.
skip	If true, skip over waypoints that already exist in the library

Returns: Human-readable error message, or an empty string on success

◆ loadFromGeoJSON()

Q_INVOKABLE QString GeoMaps::WaypointLibrary::loadFromGeoJSON ( QString fileName = {} )

nodiscard

Read from file.

Reads the library from a file in GeoJSON format. On sucess, the current library is replaced in full. On error, the current library is not touched at all.

Parameters

fileName File name. If emty, a standard file name will be used, in QStandardPaths::AppDataLocation. See the private member stdFileName for details.

Returns: An empty string on success and a human-readable tranlated error message otherwise.

◆ remove()

Q_INVOKABLE bool GeoMaps::WaypointLibrary::remove ( const GeoMaps::Waypoint & waypoint )

nodiscard

Remove waypoint.

Removes the first waypoint from the list that matches the given waypoint exactly. If no waypoint matches, this method does nothing.

Parameters

waypoint Waypoint to be removed

Returns: True if a waypoint has indeed been removed.

◆ replace()

Q_INVOKABLE bool GeoMaps::WaypointLibrary::replace	(	const GeoMaps::Waypoint &	oldWaypoint,
		const GeoMaps::Waypoint &	newWaypoint )

nodiscard

Replace waypoint.

Replaces the first waypoint from the list that matches the given oldWaypoint exactly. If no waypoint matches, this method does nothing.

Parameters

oldWaypoint	Waypoint that shall be replaced
newWaypoint	Waypoint replacement. If this waypoint is invalid, the method returns immediately and does nothing.

Returns: True if a waypoint has indeed been replaced.

◆ save()

Q_INVOKABLE QString GeoMaps::WaypointLibrary::save ( QString fileName = {} ) const

nodiscard

Save to file.

Saves the library in GeoJSON format.

Parameters

fileName File name. If emty, a standard file name will be used, in QStandardPaths::AppDataLocation. See the private member stdFileName for details.

Returns: An empty string on success and a human-readable tranlated error message otherwise.

◆ toGpx()

Q_INVOKABLE QByteArray GeoMaps::WaypointLibrary::toGpx ( ) const

nodiscard

Serialize into GPX document.

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

Returns: QByteArray containing GPX data describing the flight route

◆ waypoints()

QList< GeoMaps::Waypoint > GeoMaps::WaypointLibrary::waypoints ( ) const

inlinenodiscard

Getter function for property with the same name.

Returns: Property waypoints

Definition at line 93 of file WaypointLibrary.h.

Property Documentation

◆ GeoJSON

QByteArray GeoMaps::WaypointLibrary::GeoJSON

read

List of waypoints.

This property holds the list of waypoints, in alphabetical order.

Definition at line 82 of file WaypointLibrary.h.

◆ waypoints

QList<GeoMaps::Waypoint> GeoMaps::WaypointLibrary::waypoints

read

List of waypoints.

This property holds the list of waypoints, in alphabetical order

Definition at line 76 of file WaypointLibrary.h.

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

/home/runner/work/enroute/enroute/src/geomaps/WaypointLibrary.h

Signals

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WaypointLibrary()

Member Function Documentation

◆ add()

◆ contains()

◆ filteredWaypoints()

◆ GeoJSON()

◆ hasNearbyEntry()

◆ import()

◆ loadFromGeoJSON()

◆ remove()

◆ replace()

◆ save()

◆ toGpx()

◆ waypoints()

Property Documentation

◆ GeoJSON

◆ waypoints