Enroute Flight Navigation
A navigation app for VFR pilots
Navigation::RemainingRouteInfo Class Reference

Info about remaining route. More...

#include <RemainingRouteInfo.h>

Public Types

enum  Status : quint8 {
  NoRoute , PositionUnknown , OffRoute , NearDestination ,
  OnRoute
}
 Status. More...
 

Public Member Functions

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

Properties

GeoMaps::Waypoint nextWP
 Next waypoint in the route.
 
Units::Distance nextWP_DIST {}
 Distance to next waypoint in the route.
 
Units::Timespan nextWP_ETE {}
 ETE for flight to next waypoint in the route.
 
QDateTime nextWP_ETA
 ETA for flight to next waypoint in the route.
 
QString nextWP_ETAAsUTCString
 ETA for flight to next waypoint in the route, in UTC and as a string.
 
Units::Angle nextWP_TC {}
 TC for flight to next waypoint in the route.
 
GeoMaps::Waypoint finalWP
 Final waypoint in the route.
 
Units::Distance finalWP_DIST {}
 Distance to final waypoint in the route.
 
Units::Timespan finalWP_ETE {}
 ETE for flight to final waypoint in the route.
 
QDateTime finalWP_ETA
 ETA for flight to final waypoint in the route.
 
QString finalWP_ETAAsUTCString
 ETA for flight to final waypoint in the route, in UTC and as a string.
 
QString note
 Note.
 
Navigation::RemainingRouteInfo::Status status
 Status.
 

Friends

class Navigation::Navigator
 
auto operator== (const Navigation::RemainingRouteInfo &, const Navigation::RemainingRouteInfo &) -> bool
 Comparison.
 

Detailed Description

Info about remaining route.

This class bundles information about the remainder of the present flight. This includes next waypoint, final waypoint, as well as distance, ETE and ETA.

Consumers of this class can expect the properties nextWP* to be valid if status equals OnRoute. The properties finalWP* need not be valid in this case. They are valid only if the next waypoint differs from the final waypoint of the route.

Definition at line 45 of file RemainingRouteInfo.h.

Member Enumeration Documentation

◆ Status

Status.

Enumerator
NoRoute 

No valid route has been set.

PositionUnknown 

Valid route has been set, but no position info available.

OffRoute 

Current position is further than Leg::nearThreshold nm away from route.

NearDestination 

Current position is closer than Leg::nearThreshold to destination.

OnRoute 

Currently travelling along the route.

Definition at line 55 of file RemainingRouteInfo.h.

Member Function Documentation

◆ finalWP_ETAAsUTCString()

auto Navigation::RemainingRouteInfo::finalWP_ETAAsUTCString ( ) const -> QString
inlinenodiscard

Getter function for the property with the same name.

Returns
Property nextWP_ETAAsUTCString

Definition at line 140 of file RemainingRouteInfo.h.

◆ nextWP_ETAAsUTCString()

auto Navigation::RemainingRouteInfo::nextWP_ETAAsUTCString ( ) const -> QString
inlinenodiscard

Getter function for the property with the same name.

Returns
Property nextWP_ETAAsUTCString

Definition at line 129 of file RemainingRouteInfo.h.

Property Documentation

◆ note

QString Navigation::RemainingRouteInfo::note

Note.

This property contains an optional localized warning, if ETE cannot be computed because wind or aircraft data are missing. If no warning, then this field remains empty.

Definition at line 115 of file RemainingRouteInfo.h.


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