Leg in a flight route. More...

#include <Leg.h>

Public Member Functions
	Leg (GeoMaps::Waypoint start, GeoMaps::Waypoint end)
	Constructs a flight route leg with given start and end point.

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

auto	endPoint () const -> GeoMaps::Waypoint
	Getter function for property of the same name.

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

auto	startPoint () const -> GeoMaps::Waypoint
	Getter function for property of the same name.

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

Q_INVOKABLE QString	description (Weather::Wind wind, const Navigation::Aircraft &aircraft) const
	Brief description of Dist ETE, TC and THGetter function for property of the same name.

Q_INVOKABLE Units::Timespan	ETE (Weather::Wind wind, const Navigation::Aircraft &aircraft) const
	ETE for leg.

Q_INVOKABLE Units::Volume	Fuel (Weather::Wind wind, const Navigation::Aircraft &aircraft) const
	Estimated fuel consumption on leg.

Q_INVOKABLE Units::Speed	GS (Weather::Wind wind, const Navigation::Aircraft &aircraft) const
	Estimated ground speed on leg.

Q_INVOKABLE bool	isFollowing (const Positioning::PositionInfo &positionInfo) const
	Check if positionInfo is travelling on this leg.

Q_INVOKABLE bool	isNear (const Positioning::PositionInfo &positionInfo) const
	Check if position is closer than nearThreshold to this leg.

Q_INVOKABLE Units::Angle	TH (Weather::Wind wind, const Navigation::Aircraft &aircraft) const
	Estimated true heading on leg.

Q_INVOKABLE Units::Angle	WCA (Weather::Wind wind, const Navigation::Aircraft &aircraft) const
	Estimated WCA on leg.

Properties
Units::Distance	distance
	Length of the leg.

GeoMaps::Waypoint	endPoint
	End point of the leg.

bool	isValid
	Validity.

Units::Distance	nearThreshold
	Distance threshold.

GeoMaps::Waypoint	startPoint
	Start point of the leg.

Units::Angle	TC
	True course.

Detailed Description

Leg in a flight route.

Definition at line 37 of file Leg.h.

Constructor & Destructor Documentation

◆ Leg()

Navigation::Leg::Leg	(	GeoMaps::Waypoint	start,
		GeoMaps::Waypoint	end )

explicit

Constructs a flight route leg with given start and end point.

Parameters

start	Start point
end	End point

Member Function Documentation

◆ description()

Q_INVOKABLE QString Navigation::Leg::description	(	Weather::Wind	wind,
		const Navigation::Aircraft &	aircraft ) const

nodiscard

Brief description of Dist ETE, TC and THGetter function for property of the same name.

Parameters

wind	Estimated wind
aircraft	Aircraft in use

Returns: Estimated WCA on leg

◆ distance()

auto Navigation::Leg::distance ( ) const -> Units::Distance

nodiscard

Getter function for property of the same name.

Returns: Property distance

◆ endPoint()

auto Navigation::Leg::endPoint ( ) const -> GeoMaps::Waypoint

inlinenodiscard

Getter function for property of the same name.

Returns: Property endPoint

Definition at line 102 of file Leg.h.

◆ ETE()

Q_INVOKABLE Units::Timespan Navigation::Leg::ETE	(	Weather::Wind	wind,
		const Navigation::Aircraft &	aircraft ) const

inlinenodiscard

ETE for leg.

Parameters

wind	Estimated wind
aircraft	Aircraft in use

Returns: ETE for leg

Definition at line 145 of file Leg.h.

◆ Fuel()

Q_INVOKABLE Units::Volume Navigation::Leg::Fuel	(	Weather::Wind	wind,
		const Navigation::Aircraft &	aircraft ) const

nodiscard

Estimated fuel consumption on leg.

Parameters

wind	Estimated wind
aircraft	Aircraft in use

Returns: Estimated fuel consumption on leg

◆ GS()

Q_INVOKABLE Units::Speed Navigation::Leg::GS	(	Weather::Wind	wind,
		const Navigation::Aircraft &	aircraft ) const

nodiscard

Estimated ground speed on leg.

Parameters

wind	Estimated wind
aircraft	Aircraft in use

Returns: Estimated ground speed on leg

◆ isFollowing()

Q_INVOKABLE bool Navigation::Leg::isFollowing ( const Positioning::PositionInfo & positionInfo ) const

nodiscard

Check if positionInfo is travelling on this leg.

The positionInfo is considered to be travelling along this leg if

isNear() is true, and
the true track (TT) is known, and
the difference TT-QUJ(endPoint) is in [-60, 60] degrees
the difference TT-QUJ(startPoint) is in [120, 240] degrees

Parameters

positionInfo PositionInfo that is checked to be following

Returns: True if the conditions are met

◆ isNear()

Q_INVOKABLE bool Navigation::Leg::isNear ( const Positioning::PositionInfo & positionInfo ) const

nodiscard

Check if position is closer than nearThreshold to this leg.

Parameters

positionInfo Position that is checked to be near

Returns: True if all data is valid and position is closer than nearThreshold to this leg.

◆ isValid()

auto Navigation::Leg::isValid ( ) const -> bool

nodiscard

Getter function for property of the same name.

Returns: Property valid

◆ startPoint()

auto Navigation::Leg::startPoint ( ) const -> GeoMaps::Waypoint

inlinenodiscard

Getter function for property of the same name.

Returns: Property startPoint

Definition at line 114 of file Leg.h.

◆ TC()

auto Navigation::Leg::TC ( ) const -> Units::Angle

nodiscard

Getter function for property of the same name.

Returns: Property TC

◆ TH()

Q_INVOKABLE Units::Angle Navigation::Leg::TH	(	Weather::Wind	wind,
		const Navigation::Aircraft &	aircraft ) const

inlinenodiscard

Estimated true heading on leg.

Parameters

wind	Estimated wind
aircraft	Aircraft in use

Returns: Estimated true heading on leg

Definition at line 201 of file Leg.h.

◆ WCA()

Q_INVOKABLE Units::Angle Navigation::Leg::WCA	(	Weather::Wind	wind,
		const Navigation::Aircraft &	aircraft ) const

nodiscard

Estimated WCA on leg.

Parameters

wind	Estimated wind
aircraft	Aircraft in use

Returns: Estimated WCA on leg

Property Documentation

◆ nearThreshold

Units::Distance Navigation::Leg::nearThreshold

Distance threshold.

A position is considered near the leg if the distance is less than this threshold

Definition at line 75 of file Leg.h.

◆ TC

Units::Angle Navigation::Leg::TC

read

True course.

This property holds the true course for the leg. It holds NaN if the leg is invalid or shorter than 100m

Definition at line 85 of file Leg.h.

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

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ Leg()

Member Function Documentation

◆ description()

◆ distance()

◆ endPoint()

◆ ETE()

◆ Fuel()

◆ GS()

◆ isFollowing()

◆ isNear()

◆ isValid()

◆ startPoint()

◆ TC()

◆ TH()

◆ WCA()

Property Documentation

◆ nearThreshold

◆ TC