Abstract base class for traffic factors. More...

#include <TrafficFactor_Abstract.h>

Inheritance diagram for Traffic::TrafficFactor_Abstract:

Public Types
enum	AircraftType : quint8 { unknown , Aircraft , Airship , Balloon , Copter , Drone , Glider , HangGlider , Jet , Paraglider , Skydiver , StaticObstacle , TowPlane }
	Aircraft type. More...

Signals
void	alarmLevelChanged ()
	Notifier signal.

void	animateChanged ()
	Notifier signal.

void	callSignChanged ()
	Notifier signal.

void	colorChanged ()
	Notifier signal.

void	descriptionChanged ()
	Notifier signal.

void	hDistChanged ()
	Notifier signal.

void	IDChanged ()
	Notifier signal.

void	typeChanged ()
	Notifier signal.

void	vDistChanged ()
	Notifier signal.

void	validChanged ()
	Notifier signal.

Public Member Functions
	TrafficFactor_Abstract (QObject *parent=nullptr)
	Default constructor.

void	copyFrom (const TrafficFactor_Abstract &other)
	Copy data from other object.

auto	hasHigherPriorityThan (const TrafficFactor_Abstract &rhs) const -> bool
	Estimates if this traffic object has higher priority than other traffic object.

void	startLiveTime ()
	Starts or extends the lifetime of this object.

int	alarmLevel () const
	Getter method for property with the same name.

QBindable< int >	bindableAlarmLevel ()
	Getter method for property with the same name.

auto	animate () const -> bool
	Getter method for property with the same name.

auto	callSign () const -> QString
	Getter method for property with the same name.

auto	color () const -> QString
	Getter method for property with the same name.

auto	description () const -> QString
	Getter method for property with the same name.

Units::Distance	hDist () const
	Getter method for property with the same name.

QBindable< Units::Distance >	bindableHDist ()
	Getter method for property with the same name.

auto	ID () const -> QString
	Getter method for property with the same name.

bool	relevant () const
	Getter method for property with the same name.

QBindable< bool >	bindableRelevant ()
	Getter method for property with the same name.

QString	relevantString () const
	Getter method for property with the same name.

QBindable< bool >	bindableRelevantString ()
	Getter method for property with the same name.

Traffic::TrafficFactor_Abstract::AircraftType	type () const
	Getter method for property with the same name.

QBindable< Traffic::TrafficFactor_Abstract::AircraftType >	bindableType ()
	Getter method for property with the same name.

QString	typeString () const
	Getter method for property with the same name.

QBindable< QString >	bindableTypeString ()
	Getter method for property with the same name.

bool	valid () const
	Getter method for property with the same name.

QBindable< bool >	bindableValid ()
	Getter method for property with the same name.

Units::Distance	vDist () const
	Getter method for property with the same name.

QBindable< Units::Distance >	bindableVDist ()
	Getter method for property with the same name.

void	setAlarmLevel (int newAlarmLevel)
	Setter function for property with the same name.

void	setAnimate (bool newAnimate)
	Setter function for property with the same name.

void	setCallSign (const QString &newCallSign)
	Setter function for property with the same name.

void	setHDist (Units::Distance newHDist)
	Setter function for property with the same name.

void	setID (const QString &newID)
	Setter function for property with the same name.

void	setType (Traffic::TrafficFactor_Abstract::AircraftType newType)
	Setter function for property with the same name.

void	setVDist (Units::Distance newVDist)
	Setter function for property with the same name.

Static Public Attributes
static constexpr auto	lifeTime = 10s
	Length of lifetime for objects of this class.

static constexpr Units::Distance	maxVerticalDistance = Units::Distance::fromM(1500.0)
	Maximal vertical distance for relevant traffic.

static constexpr Units::Distance	maxHorizontalDistance = Units::Distance::fromNM(20.0)
	Maximal horizontal distance for relevant traffic.

Properties
int	alarmLevel
	Alarm Level.

bool	animate
	Indicates if changes in properties should be animated in the GUI.

QString	callSign
	Call sign.

QString	color
	Suggested color for GUI representation of the traffic.

QString	description
	Description of the traffic, for use in GUI.

Units::Distance	hDist
	Horizontal distance from own position to the traffic, at the time of report.

QString	ID
	Identifier string of the traffic.

bool	relevant
	Indicates relevant traffic.

QString	relevantString
	Translated string containing the 'relevant' property.

AircraftType	type
	Type of aircraft, as reported by the traffic receiver.

QString	typeString
	Type of aircraft, as reported by the traffic receiver.

bool	valid
	Validity.

Units::Distance	vDist
	Vertical distance from own position to the traffic, at the time of report.

Detailed Description

Abstract base class for traffic factors.

This is an abstract base class for traffic factors, as reported by traffic data receivers (e.g. FLARM devices).

Since the real-world traffic situation changes continuously, instances of this class have a limited lifetime. The length of the lifetime is specified in the constant "lifeTime". You can (re)start an object's lifetime startLiveTime(). Once the lift-time of an object is expired, the property "valid" will alway contain the word "false", regardless of the object's other properties.

Definition at line 44 of file TrafficFactor_Abstract.h.

Member Enumeration Documentation

◆ AircraftType

enum Traffic::TrafficFactor_Abstract::AircraftType : quint8

Aircraft type.

This enum defines a few aircraft type. The list is modeled after the FLARM/NMEA specification.

Enumerator
unknown	Unknown aircraft type
Aircraft	Fixed wing aircraft
Airship	Airship, such as a zeppelin or a blimp
Balloon	Balloon
Copter	Helicopter, gyrocopter or rotorcraft
Drone	Drone
Glider	Glider, including powered gliders and touring motor gliders
HangGlider	Hang glider
Jet	Jet aircraft
Paraglider	Paraglider
Skydiver	Skydiver
StaticObstacle	Static obstacle
TowPlane	Tow plane

Definition at line 55 of file TrafficFactor_Abstract.h.

Constructor & Destructor Documentation

◆ TrafficFactor_Abstract()

Traffic::TrafficFactor_Abstract::TrafficFactor_Abstract ( QObject * parent = nullptr )

explicit

Default constructor.

Parameters

parent The standard QObject parent pointer

Member Function Documentation

◆ alarmLevel()

int Traffic::TrafficFactor_Abstract::alarmLevel ( ) const

inlinenodiscard

Getter method for property with the same name.

Returns: Property alarmLevel

Definition at line 248 of file TrafficFactor_Abstract.h.

◆ animate()

auto Traffic::TrafficFactor_Abstract::animate ( ) const -> bool

inlinenodiscard

Getter method for property with the same name.

Returns: Property animate

Definition at line 260 of file TrafficFactor_Abstract.h.

◆ bindableAlarmLevel()

QBindable< int > Traffic::TrafficFactor_Abstract::bindableAlarmLevel ( )

inlinenodiscard

Getter method for property with the same name.

Returns: Property alarmLevel

Definition at line 254 of file TrafficFactor_Abstract.h.

◆ bindableHDist()

QBindable< Units::Distance > Traffic::TrafficFactor_Abstract::bindableHDist ( )

inlinenodiscard

Getter method for property with the same name.

Returns: Property hDist

Definition at line 308 of file TrafficFactor_Abstract.h.

◆ bindableRelevant()

QBindable< bool > Traffic::TrafficFactor_Abstract::bindableRelevant ( )

inlinenodiscard

Getter method for property with the same name.

Returns: Property relevant

Definition at line 329 of file TrafficFactor_Abstract.h.

◆ bindableRelevantString()

QBindable< bool > Traffic::TrafficFactor_Abstract::bindableRelevantString ( )

inlinenodiscard

Getter method for property with the same name.

Returns: Property relevantString

Definition at line 341 of file TrafficFactor_Abstract.h.

◆ bindableType()

QBindable< Traffic::TrafficFactor_Abstract::AircraftType > Traffic::TrafficFactor_Abstract::bindableType ( )

inlinenodiscard

Getter method for property with the same name.

Returns: Property type

Definition at line 353 of file TrafficFactor_Abstract.h.

◆ bindableTypeString()

QBindable< QString > Traffic::TrafficFactor_Abstract::bindableTypeString ( )

inlinenodiscard

Getter method for property with the same name.

Returns: Property typeString

Definition at line 365 of file TrafficFactor_Abstract.h.

◆ bindableValid()

QBindable< bool > Traffic::TrafficFactor_Abstract::bindableValid ( )

inlinenodiscard

Getter method for property with the same name.

Returns: Property valid

Definition at line 377 of file TrafficFactor_Abstract.h.

◆ bindableVDist()

QBindable< Units::Distance > Traffic::TrafficFactor_Abstract::bindableVDist ( )

inlinenodiscard

Getter method for property with the same name.

Returns: Property vDist

Definition at line 389 of file TrafficFactor_Abstract.h.

◆ callSign()

auto Traffic::TrafficFactor_Abstract::callSign ( ) const -> QString

inlinenodiscard

Getter method for property with the same name.

Returns: Property callSign

Definition at line 269 of file TrafficFactor_Abstract.h.

◆ color()

auto Traffic::TrafficFactor_Abstract::color ( ) const -> QString

inlinenodiscard

Getter method for property with the same name.

Returns: Property color

Definition at line 278 of file TrafficFactor_Abstract.h.

◆ copyFrom()

void Traffic::TrafficFactor_Abstract::copyFrom ( const TrafficFactor_Abstract & other )

inline

Copy data from other object.

This method copies all properties from the other object, with two notable exceptions.

The property "animate" is not copied, the property "animate" of this class is not touched.
The lifeTime of this object is not changed.

Parameters

other Instance whose properties are copied

Definition at line 96 of file TrafficFactor_Abstract.h.

◆ description()

auto Traffic::TrafficFactor_Abstract::description ( ) const -> QString

inlinenodiscard

Getter method for property with the same name.

Returns: Property description

Definition at line 293 of file TrafficFactor_Abstract.h.

◆ hasHigherPriorityThan()

auto Traffic::TrafficFactor_Abstract::hasHigherPriorityThan ( const TrafficFactor_Abstract & rhs ) const -> bool

nodiscard

Estimates if this traffic object has higher priority than other traffic object.

The following criteria are applied in order.

Valid traffic objects have higher priority than invalid objects.
Traffic objects with higher alarm level have higher priority.
Traffic objects that are closer have higher priority.

Parameters

rhs	Right hand side of the comparison

Returns: Boolean with the result

◆ hDist()

Units::Distance Traffic::TrafficFactor_Abstract::hDist ( ) const

inlinenodiscard

Getter method for property with the same name.

Returns: Property hDist

Definition at line 302 of file TrafficFactor_Abstract.h.

◆ ID()

auto Traffic::TrafficFactor_Abstract::ID ( ) const -> QString

inlinenodiscard

Getter method for property with the same name.

Returns: Property ID

Definition at line 314 of file TrafficFactor_Abstract.h.

◆ relevant()

bool Traffic::TrafficFactor_Abstract::relevant ( ) const

inlinenodiscard

Getter method for property with the same name.

Returns: Property relevant

Definition at line 323 of file TrafficFactor_Abstract.h.

◆ relevantString()

QString Traffic::TrafficFactor_Abstract::relevantString ( ) const

inlinenodiscard

Getter method for property with the same name.

Returns: Property relevant

Definition at line 335 of file TrafficFactor_Abstract.h.

◆ setAlarmLevel()

void Traffic::TrafficFactor_Abstract::setAlarmLevel ( int newAlarmLevel )

inline

Setter function for property with the same name.

Parameters

newAlarmLevel Property alarmLevel

Definition at line 400 of file TrafficFactor_Abstract.h.

◆ setAnimate()

void Traffic::TrafficFactor_Abstract::setAnimate ( bool newAnimate )

inline

Setter function for property with the same name.

Parameters

newAnimate Property animate

Definition at line 414 of file TrafficFactor_Abstract.h.

◆ setCallSign()

void Traffic::TrafficFactor_Abstract::setCallSign ( const QString & newCallSign )

inline

Setter function for property with the same name.

Parameters

newCallSign Property callSign

Definition at line 426 of file TrafficFactor_Abstract.h.

◆ setHDist()

void Traffic::TrafficFactor_Abstract::setHDist ( Units::Distance newHDist )

inline

Setter function for property with the same name.

Parameters

newHDist Property hDist

Definition at line 438 of file TrafficFactor_Abstract.h.

◆ setID()

void Traffic::TrafficFactor_Abstract::setID ( const QString & newID )

inline

Setter function for property with the same name.

Parameters

newID Property ID

Definition at line 444 of file TrafficFactor_Abstract.h.

◆ setType()

void Traffic::TrafficFactor_Abstract::setType ( Traffic::TrafficFactor_Abstract::AircraftType newType )

inline

Setter function for property with the same name.

Parameters

newType Property type

Definition at line 456 of file TrafficFactor_Abstract.h.

◆ setVDist()

void Traffic::TrafficFactor_Abstract::setVDist ( Units::Distance newVDist )

inline

Setter function for property with the same name.

Parameters

newVDist Property vDist

Definition at line 462 of file TrafficFactor_Abstract.h.

◆ startLiveTime()

void Traffic::TrafficFactor_Abstract::startLiveTime ( )

Starts or extends the lifetime of this object.

Traffic information is valantile, and is considered valid only for "lifeTime" seconds. This method starts or extends the object's life time.

◆ type()

Traffic::TrafficFactor_Abstract::AircraftType Traffic::TrafficFactor_Abstract::type ( ) const

inlinenodiscard

Getter method for property with the same name.

Returns: Property type

Definition at line 347 of file TrafficFactor_Abstract.h.

◆ typeString()

QString Traffic::TrafficFactor_Abstract::typeString ( ) const

inlinenodiscard

Getter method for property with the same name.

Returns: Property typeString

Definition at line 359 of file TrafficFactor_Abstract.h.

◆ valid()

bool Traffic::TrafficFactor_Abstract::valid ( ) const

inlinenodiscard

Getter method for property with the same name.

Returns: Property valid

Definition at line 371 of file TrafficFactor_Abstract.h.

◆ vDist()

Units::Distance Traffic::TrafficFactor_Abstract::vDist ( ) const

inlinenodiscard

Getter method for property with the same name.

Returns: Property vDist

Definition at line 383 of file TrafficFactor_Abstract.h.

Member Data Documentation

◆ maxHorizontalDistance

Units::Distance Traffic::TrafficFactor_Abstract::maxHorizontalDistance = Units::Distance::fromNM(20.0)

staticconstexpr

Maximal horizontal distance for relevant traffic.

Traffic whose horizontal distance to the own aircraft is larger than this number will be considered irrelevant.

Definition at line 481 of file TrafficFactor_Abstract.h.

◆ maxVerticalDistance

Units::Distance Traffic::TrafficFactor_Abstract::maxVerticalDistance = Units::Distance::fromM(1500.0)

staticconstexpr

Maximal vertical distance for relevant traffic.

Traffic whose vertical distance to the own aircraft is larger than this number will be considered irrelevant.

Definition at line 474 of file TrafficFactor_Abstract.h.

Property Documentation

◆ alarmLevel

int Traffic::TrafficFactor_Abstract::alarmLevel

readwrite

Alarm Level.

This is the alarm level associated with the traffic object. The alarm level is an integer in the range 0 (no alarm), …, 3 (maximal alarm). The values are not computed by this class, but reported by the traffic receiver that reports the traffic. The precise meaning depends on the type of traffic receiver used.

FLARM

0 = no alarm (also used for no-alarm traffic information)
1 = alarm, 13-18 seconds to impact
2 = alarm, 9-12 seconds to impact
3 = alarm, 0-8 seconds to impact

Other

0 = no alarm
1 = alarm

Definition at line 154 of file TrafficFactor_Abstract.h.

◆ animate

bool Traffic::TrafficFactor_Abstract::animate

readwrite

Indicates if changes in properties should be animated in the GUI.

This boolen properts is used to indicate if changes in properties should be animated in the GUI. This property is typically set to "true" before gradual changes are applied, such as the position change of an aircraft. It is typically set to "false" before data of a new aircraft set.

Definition at line 163 of file TrafficFactor_Abstract.h.

◆ callSign

QString Traffic::TrafficFactor_Abstract::callSign

readwrite

Call sign.

If known, this property holds the call sign of the traffic. Otherwise, it contains an empty string

Definition at line 169 of file TrafficFactor_Abstract.h.

◆ color

QString Traffic::TrafficFactor_Abstract::color

read

Suggested color for GUI representation of the traffic.

This propery suggests a color, depending on the alarmLevel.

alarmLevel == 0: green
alarmLevel == 1: yellow
alarmLevel >= 2: red

Definition at line 179 of file TrafficFactor_Abstract.h.

◆ description

QString Traffic::TrafficFactor_Abstract::description

read

Description of the traffic, for use in GUI.

This method holds a human-readable, translated description of the traffic. This is a rich-text string of the form "Glider<br>+15 0m" or "Airship<br>Position unknown<br>-45 ft".

Definition at line 187 of file TrafficFactor_Abstract.h.

◆ hDist

Units::Distance Traffic::TrafficFactor_Abstract::hDist

readwrite

Horizontal distance from own position to the traffic, at the time of report.

If known, this property holds the horizontal distance from the own position to the traffic, at the time of report. Otherwise, it contains an invalid distance.

Definition at line 195 of file TrafficFactor_Abstract.h.

◆ ID

QString Traffic::TrafficFactor_Abstract::ID

readwrite

Identifier string of the traffic.

This property holds an identifier string for the traffic, as assigned by the FLARM device that reported the traffic. This can be the FLARM ID, or an empty string if no meaningful ID can be assigned.

Definition at line 203 of file TrafficFactor_Abstract.h.

◆ relevant

bool Traffic::TrafficFactor_Abstract::relevant

read

Indicates relevant traffic.

This property holds 'true' if the traffic is valid, and closer than maxVerticalDistance and maxHorizontalDistance specified below.

Definition at line 210 of file TrafficFactor_Abstract.h.

◆ typeString

QString Traffic::TrafficFactor_Abstract::typeString

read

Type of aircraft, as reported by the traffic receiver.

This property holds a translated, human-readable string.

Definition at line 222 of file TrafficFactor_Abstract.h.

◆ valid

bool Traffic::TrafficFactor_Abstract::valid

read

Validity.

A traffic object is considered valid if the data is meaningful and if the lifetime is not expired. Only valid traffic objects should be shown in the GUI.

Definition at line 229 of file TrafficFactor_Abstract.h.

◆ vDist

Units::Distance Traffic::TrafficFactor_Abstract::vDist

readwrite

Vertical distance from own position to the traffic, at the time of report.

If known, this property holds the vertical distance from the own position to the traffic, at the time of report. Otherwise, it contains NaN.

Definition at line 237 of file TrafficFactor_Abstract.h.

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

/home/runner/work/enroute/enroute/src/traffic/TrafficFactor_Abstract.h

Public Types

Signals

Public Member Functions

Static Public Attributes

Properties

Detailed Description

Member Enumeration Documentation

◆ AircraftType

Constructor & Destructor Documentation

◆ TrafficFactor_Abstract()

Member Function Documentation

◆ alarmLevel()

◆ animate()

◆ bindableAlarmLevel()

◆ bindableHDist()

◆ bindableRelevant()

◆ bindableRelevantString()

◆ bindableType()

◆ bindableTypeString()

◆ bindableValid()

◆ bindableVDist()

◆ callSign()

◆ color()

◆ copyFrom()

◆ description()

◆ hasHigherPriorityThan()

◆ hDist()

◆ ID()

◆ relevant()

◆ relevantString()

◆ setAlarmLevel()

◆ setAnimate()

◆ setCallSign()

◆ setHDist()

◆ setID()

◆ setType()

◆ setVDist()

◆ startLiveTime()

◆ type()

◆ typeString()

◆ valid()

◆ vDist()

Member Data Documentation

◆ maxHorizontalDistance

◆ maxVerticalDistance

Property Documentation

◆ alarmLevel

◆ animate

◆ callSign

◆ color

◆ description

◆ hDist

◆ ID

◆ relevant

◆ typeString

◆ valid

◆ vDist