This extremely simple class holds a few numbers that describe an aircraft. More...

#include <Aircraft.h>

Public Types
enum	FuelConsumptionUnit : quint8 { LiterPerHour = 0 , GallonPerHour = 1 }
	Units of measurement for volumes. More...

enum	HorizontalDistanceUnit : quint8 { NauticalMile = 0 , Kilometer = 1 , StatuteMile = 2 }
	Units of measurement for horizontal distances. More...

enum	VerticalDistanceUnit : quint8 { Feet = 0 , Meters = 1 }
	Units of measurement for vertical distances. More...

Public Member Functions
auto	cruiseSpeed () const -> Units::Speed
	Getter function for property of the same name.

auto	descentSpeed () const -> Units::Speed
	Getter function for property of the same name.

auto	fuelConsumption () const -> Units::VolumeFlow
	Getter function for property of the same name.

auto	fuelConsumptionUnit () const -> FuelConsumptionUnit
	Getter function for property of the same name.

auto	horizontalDistanceUnit () const -> HorizontalDistanceUnit
	Getter function for property of the same name.

auto	minimumSpeed () const -> Units::Speed
	Getter function for property of the same name.

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

auto	verticalDistanceUnit () const -> VerticalDistanceUnit
	Getter function for property of the same name.

void	setCruiseSpeed (Units::Speed newSpeed)
	Setter function for property of the same name.

void	setDescentSpeed (Units::Speed newSpeed)
	Setter function for property of the same name.

void	setFuelConsumption (Units::VolumeFlow newFuelConsumption)
	Setter function for property of the same name.

void	setFuelConsumptionUnit (FuelConsumptionUnit newUnit)
	Setter function for property of the same name.

void	setHorizontalDistanceUnit (HorizontalDistanceUnit newUnit)
	Setter function for property of the same name.

void	setMinimumSpeed (Units::Speed newSpeed)
	Setter function for property of the same name.

void	setName (const QString &newName)
	Setter function for property of the same name.

void	setVerticalDistanceUnit (VerticalDistanceUnit newUnit)
	Setter function for property of the same name.

Q_INVOKABLE Navigation::Aircraft	clone () const
	Return copy of this object.

Q_INVOKABLE QString	describeWay (const QGeoCoordinate &from, const QGeoCoordinate &to) const
	Description of the way between two points.

Q_INVOKABLE QString	horizontalDistanceToString (Units::Distance distance) const
	Convert horizontal distance to string.

Q_INVOKABLE QString	horizontalSpeedToString (Units::Speed speed) const
	Convert horizontal speed to string.

Q_INVOKABLE QString	loadFromJSON (const QString &fileName)
	Reads aircraft data from a JSON document.

Q_INVOKABLE QString	loadFromJSON (const QByteArray &JSON)
	Reads aircraft data from a JSON document.

Q_INVOKABLE bool	operator== (const Navigation::Aircraft &other) const
	Equality check.

Q_INVOKABLE QString	save (const QString &fileName) const
	Saves aircraft to a file.

Q_INVOKABLE QByteArray	toJSON () const
	Exports to route to JSON.

Q_INVOKABLE QString	verticalDistanceToString (Units::Distance distance, bool forceSign=false) const
	Convert vertical distance to string.

Q_INVOKABLE QString	verticalSpeedToString (Units::Speed speed) const
	Convert vertical speed to string.

Q_INVOKABLE QString	volumeToString (Units::Volume volume) const
	Convert volume to string.

Properties
Units::Speed	cruiseSpeed
	Cruise Speed.

Units::Speed	descentSpeed
	Decent Speed.

Units::VolumeFlow	fuelConsumption
	Fuel Consumption.

FuelConsumptionUnit	fuelConsumptionUnit
	Preferred units of measurement for fuel consumption.

HorizontalDistanceUnit	horizontalDistanceUnit
	Preferred units of measurement for horizontal distances.

Units::Speed	maxValidSpeed
	Maximal speed of the aircraft that is considered valid.

Units::VolumeFlow	maxValidFuelConsumption
	Maximal fuel consumption that is considered valid.

Units::Speed	minimumSpeed
	Minimum Speed.

Units::VolumeFlow	minValidFuelConsumption
	Minimal fuel consumption that is considered valid.

Units::Speed	minValidSpeed
	Minimal speed of the aircraft that is considered valid.

QString	name
	Name.

VerticalDistanceUnit	verticalDistanceUnit
	Preferred units of measurement for vertical distances.

Detailed Description

This extremely simple class holds a few numbers that describe an aircraft.

Definition at line 35 of file Aircraft.h.

Member Enumeration Documentation

◆ FuelConsumptionUnit

enum Navigation::Aircraft::FuelConsumptionUnit : quint8

Units of measurement for volumes.

Enumerator
LiterPerHour	Liter per hour.
GallonPerHour	Gallon per hour.

Definition at line 41 of file Aircraft.h.

◆ HorizontalDistanceUnit

enum Navigation::Aircraft::HorizontalDistanceUnit : quint8

Units of measurement for horizontal distances.

Enumerator
NauticalMile	Nautical Mile.
Kilometer	Kilometer.
StatuteMile	Statute Mile.

Definition at line 51 of file Aircraft.h.

◆ VerticalDistanceUnit

enum Navigation::Aircraft::VerticalDistanceUnit : quint8

Units of measurement for vertical distances.

Enumerator
Feet	Feet.
Meters	Meters.

Definition at line 64 of file Aircraft.h.

Member Function Documentation

◆ clone()

Q_INVOKABLE Navigation::Aircraft Navigation::Aircraft::clone ( ) const

inlinenodiscard

Return copy of this object.

This is a helper function, used in QML to create explicit copies of this object.

Returns: Copy of this object

Definition at line 259 of file Aircraft.h.

◆ cruiseSpeed()

auto Navigation::Aircraft::cruiseSpeed ( ) const -> Units::Speed

inlinenodiscard

Getter function for property of the same name.

Returns: Property cruise speed

Definition at line 144 of file Aircraft.h.

◆ descentSpeed()

auto Navigation::Aircraft::descentSpeed ( ) const -> Units::Speed

inlinenodiscard

Getter function for property of the same name.

Returns: Property descentSpeed

Definition at line 150 of file Aircraft.h.

◆ describeWay()

Q_INVOKABLE QString Navigation::Aircraft::describeWay	(	const QGeoCoordinate &	from,
		const QGeoCoordinate &	to ) const

nodiscard

Description of the way between two points.

Parameters

from	Starting point of the way
to	Endpoint of the way

Returns: A string such as "DIST 65.2 nm • QUJ 276°" or "DIST 65.2 km • QUJ 276°". If the way cannot be described (e.g. because one of the coordinates is invalid), then an empty string is returned.

◆ fuelConsumption()

auto Navigation::Aircraft::fuelConsumption ( ) const -> Units::VolumeFlow

inlinenodiscard

Getter function for property of the same name.

Returns: Property fuelConsumptionInLPH

Definition at line 156 of file Aircraft.h.

◆ fuelConsumptionUnit()

auto Navigation::Aircraft::fuelConsumptionUnit ( ) const -> FuelConsumptionUnit

inlinenodiscard

Getter function for property of the same name.

Returns: Property preferredVolumeUnit

Definition at line 162 of file Aircraft.h.

◆ horizontalDistanceToString()

Q_INVOKABLE QString Navigation::Aircraft::horizontalDistanceToString ( Units::Distance distance ) const

nodiscard

Convert horizontal distance to string.

This method converts a horizontal distance to a localized string, taking horizontalDistanceUnit into account.

Parameters

distance Distance

Returns: A string of the form "280 km", or "-" for an invalid distance

◆ horizontalDistanceUnit()

auto Navigation::Aircraft::horizontalDistanceUnit ( ) const -> HorizontalDistanceUnit

inlinenodiscard

Getter function for property of the same name.

Returns: Property preferredHorizontalDistanceUnit

Definition at line 168 of file Aircraft.h.

◆ horizontalSpeedToString()

Q_INVOKABLE QString Navigation::Aircraft::horizontalSpeedToString ( Units::Speed speed ) const

nodiscard

Convert horizontal speed to string.

This method converts a horizontal speed to a localized string, taking horizontalDistanceUnit into account.

Parameters

speed Speed

Returns: A string of the form "98 kn", "154 km/h", or "-"

◆ loadFromJSON() [1/2]

Q_INVOKABLE QString Navigation::Aircraft::loadFromJSON ( const QByteArray & JSON )

nodiscard

Reads aircraft data from a JSON document.

This method loads reads data from a JSON document and stores it in the present object. Notifier signals are emitted as appropriate. If this method returns a non-empty string, then the JSON data might be partially read.

Parameters

JSON JSON data

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

◆ loadFromJSON() [2/2]

Q_INVOKABLE QString Navigation::Aircraft::loadFromJSON ( const QString & fileName )

nodiscard

Reads aircraft data from a JSON document.

This method loads reads data from a JSON document and stores it in the present object. Notifier signals are emitted as appropriate. If this method returns a non-empty string, then the JSON data might be partially read.

Parameters

fileName File name

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

◆ minimumSpeed()

auto Navigation::Aircraft::minimumSpeed ( ) const -> Units::Speed

inlinenodiscard

Getter function for property of the same name.

Returns: Property minimum speed

Definition at line 174 of file Aircraft.h.

◆ name()

auto Navigation::Aircraft::name ( ) const -> QString

inlinenodiscard

Getter function for property of the same name.

Returns: Property name

Definition at line 180 of file Aircraft.h.

◆ operator==()

Q_INVOKABLE bool Navigation::Aircraft::operator== ( const Navigation::Aircraft & other ) const

Equality check.

Parameters

other Aircraft that is compared to this

Returns: equality

◆ save()

Q_INVOKABLE QString Navigation::Aircraft::save ( const QString & fileName ) const

nodiscard

Saves aircraft to a file.

This method saves the aircraft as a JSON file.

Parameters

fileName File name, needs to include path and extension

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