Base class for all traffic receiver data sources. More...

#include <TrafficDataSource_Abstract.h>

Inheritance diagram for Traffic::TrafficDataSource_Abstract:

Public Slots
virtual void	connectToTrafficReceiver ()=0
	Start attempt to connect to traffic receiver.

virtual void	disconnectFromTrafficReceiver ()=0
	Disconnect from traffic receiver.

virtual void	setPassword (const QString &SSID, const QString &password)
	Set password.

Signals
void	connectivityStatusChanged (QString newStatus)
	Notifier signal.

void	errorStringChanged (QString newError)
	Notifier signal.

void	factorWithoutPosition (const Traffic::TrafficFactor_DistanceOnly &factor)
	Traffic factor without position.

void	factorWithPosition (const Traffic::TrafficFactor_WithPosition &factor)
	Traffic factor with position.

void	positionUpdated (Positioning::PositionInfo pInfo)
	Position info.

void	receivingHeartbeatChanged (bool)
	Notifier signal.

void	trafficReceiverRuntimeErrorChanged ()
	Notifier signal.

void	trafficReceiverSelfTestErrorChanged ()
	Notifier signal.

void	trafficReceiverHwVersion (QString result)
	Traffic receiver hardware version.

void	trafficReceiverObVersion (QString result)
	Traffic receiver obstacle database version.

void	trafficReceiverSwVersion (QString result)
	Traffic receiver software version.

void	warning (const Traffic::Warning &warning)
	Traffic warning.

Public Member Functions
	TrafficDataSource_Abstract (bool isCanonical, QObject *parent)
	Default constructor.

bool	canonical () const
	Getter function for the property with the same name.

virtual Traffic::ConnectionInfo	connectionInfo () const
	Getter function for the property with the same name.

QString	connectivityStatus () const
	Getter function for the property with the same name.

virtual QString	dataFormat () const =0
	Getter function for the property with the same name.

QString	errorString () const
	Getter function for the property with the same name.

virtual QString	icon () const =0
	Getter function for the property with the same name.

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

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

bool	receivingHeartbeat () const
	Getter function for the property with the same name.

virtual QString	sourceName () const =0
	Getter function for the property with the same name.

QString	trafficReceiverRuntimeError () const
	Getter function for the property with the same name.

QString	trafficReceiverSelfTestError () const
	Getter function for the property with the same name.

Protected Member Functions
void	processFLARMData (const QString &data)
	Process FLARM/NMEA data.

void	processGDLMessage (const QByteArray &message)
	Process one GDL90 message.

void	processXGPSString (const QByteArray &data)
	Process one XGPS string.

void	resetReceivingHeartbeat ()
	Resetter method for the property with the same name.

void	setConnectivityStatus (const QString &newConnectivityStatus)
	Setter function for the property with the same name.

void	setErrorString (const QString &newErrorString=QString())
	Setter function for the property with the same name.

void	setPressureAltitude (Units::Distance newPressureAltitude)
	Setter function for the property with the same name.

void	setReceivingHeartbeat (bool newReceivingHeartbeat)
	Setter method for the property with the same name.

void	setTrafficReceiverRuntimeError (const QString &newErrorString)
	Setter function for the property with the same name.

void	setTrafficReceiverSelfTestError (const QString &newErrorString)
	Setter function for the property with the same name.

Properties
bool	canonical
	Canonicity.

QString	connectivityStatus
	Connectivity status.

Traffic::ConnectionInfo	connectionInfo
	Connection Info.

QString	dataFormat
	Data format.

QString	errorString
	String describing the last socket error.

QString	icon
	Icon that can be used to represent the connection in a GUI.

Units::Distance	pressureAltitude
	Pressure altitude.

bool	receivingHeartbeat
	Heartbeat indicator.

QString	sourceName
	Source name.

QString	trafficReceiverRuntimeError
	String describing the last traffic data receiver runtime error.

QString	trafficReceiverSelfTestError
	String describing the last traffic data receiver self-test error.

Detailed Description

Base class for all traffic receiver data sources.

This is an abstract base class for all classes that connect to a traffic receiver. In addition to the properties listed below, the class also emits imporant data via the signals barometricAltitudeUpdated, factorWithoutPosition, factorWithPosition and warning. It contains methods to interpret FLARM and GDL90 data streams.

Definition at line 42 of file TrafficDataSource_Abstract.h.

Constructor & Destructor Documentation

◆ TrafficDataSource_Abstract()

Traffic::TrafficDataSource_Abstract::TrafficDataSource_Abstract	(	bool	isCanonical,
		QObject *	parent )

Default constructor.

Parameters

isCanonical	Intializer for property canonical
parent	The standard QObject parent pointer

Member Function Documentation

◆ bindablePressureAltitude()

QBindable< Units::Distance > Traffic::TrafficDataSource_Abstract::bindablePressureAltitude ( ) const

inlinenodiscard

Getter method for property with the same name.

Returns: Property pressureAltitude

Definition at line 216 of file TrafficDataSource_Abstract.h.

◆ canonical()

bool Traffic::TrafficDataSource_Abstract::canonical ( ) const

inlinenodiscard

Getter function for the property with the same name.

Returns: Property canonical

Definition at line 165 of file TrafficDataSource_Abstract.h.

◆ connectionInfo()

virtual Traffic::ConnectionInfo Traffic::TrafficDataSource_Abstract::connectionInfo ( ) const

inlinenodiscardvirtual

Getter function for the property with the same name.

Returns: Property connectionInfo

Reimplemented in Traffic::TrafficDataSource_BluetoothClassic, Traffic::TrafficDataSource_BluetoothLowEnergy, Traffic::TrafficDataSource_SerialPort, Traffic::TrafficDataSource_Tcp, and Traffic::TrafficDataSource_Udp.

Definition at line 174 of file TrafficDataSource_Abstract.h.

◆ connectivityStatus()

QString Traffic::TrafficDataSource_Abstract::connectivityStatus ( ) const

inlinenodiscard

Getter function for the property with the same name.

Returns: Property connectivityStatus

Definition at line 180 of file TrafficDataSource_Abstract.h.

◆ connectToTrafficReceiver

virtual void Traffic::TrafficDataSource_Abstract::connectToTrafficReceiver ( )

pure virtualslot

Start attempt to connect to traffic receiver.

If this class is connected to a traffic receiver, this method does nothing. Otherwise, it stops any ongoing connection attempt and starts a new attempt to connect to a potential receiver.

◆ dataFormat()

virtual QString Traffic::TrafficDataSource_Abstract::dataFormat ( ) const

nodiscardpure virtual

Getter function for the property with the same name.

Returns: Property dataFormat

Implemented in Traffic::TrafficDataSource_BluetoothClassic, Traffic::TrafficDataSource_BluetoothLowEnergy, Traffic::TrafficDataSource_File, Traffic::TrafficDataSource_SerialPort, Traffic::TrafficDataSource_Simulate, Traffic::TrafficDataSource_Tcp, and Traffic::TrafficDataSource_Udp.

◆ disconnectFromTrafficReceiver

virtual void Traffic::TrafficDataSource_Abstract::disconnectFromTrafficReceiver ( )

pure virtualslot

Disconnect from traffic receiver.

This method stops any ongoing connection or connection attempt. This method will not reset the property errorString, so that the error remains visible even after the class has been disconnected from the traffic receiver.

◆ errorString()

QString Traffic::TrafficDataSource_Abstract::errorString ( ) const

inlinenodiscard

Getter function for the property with the same name.

Returns: Property errorString

Definition at line 195 of file TrafficDataSource_Abstract.h.

◆ factorWithoutPosition

void Traffic::TrafficDataSource_Abstract::factorWithoutPosition ( const Traffic::TrafficFactor_DistanceOnly & factor )

signal

Traffic factor without position.

This signal is emitted when the traffic receiver informs this class about traffic whose position is not known.

Parameters

factor Traffic factor.

◆ factorWithPosition

void Traffic::TrafficDataSource_Abstract::factorWithPosition ( const Traffic::TrafficFactor_WithPosition & factor )

signal

Traffic factor with position.

This signal is emitted when the traffic receiver informs this class about traffic whose position is known.

Parameters

factor Traffic factor.

◆ icon()

virtual QString Traffic::TrafficDataSource_Abstract::icon ( ) const

nodiscardpure virtual

Getter function for the property with the same name.

Returns: Property icon

Implemented in Traffic::TrafficDataSource_BluetoothClassic, Traffic::TrafficDataSource_BluetoothLowEnergy, Traffic::TrafficDataSource_File, Traffic::TrafficDataSource_SerialPort, Traffic::TrafficDataSource_Simulate, Traffic::TrafficDataSource_Tcp, and Traffic::TrafficDataSource_Udp.

◆ positionUpdated

void Traffic::TrafficDataSource_Abstract::positionUpdated ( Positioning::PositionInfo pInfo )

signal

Position info.

If this class received position information from a connected traffic receiver, this information is emitted here.

◆ pressureAltitude()

Units::Distance Traffic::TrafficDataSource_Abstract::pressureAltitude ( ) const

inlinenodiscard

Getter method for property with the same name.

Returns: Property pressureAltitude

Definition at line 210 of file TrafficDataSource_Abstract.h.

◆ processFLARMData()

void Traffic::TrafficDataSource_Abstract::processFLARMData ( const QString & data )

protected

Process FLARM/NMEA data.

This method handles FLARM/NMEA data. It collects data until a full FLARM/NMEA sentence is found and then calls processFLARMSentence() to handle that sentence.

Parameters

data	A QString containing FLARM/NMEA data.

◆ processGDLMessage()

void Traffic::TrafficDataSource_Abstract::processGDLMessage ( const QByteArray & message )

protected

Process one GDL90 message.

This method expects exactly one GDL90 message, including starting and trailing 0x7e bytes. The method interprets the string and updates the properties and emits signals as appropriate. Invalid messages are silently ignored.

Parameters

message A QByteArray containing a GDL90 message.

◆ processXGPSString()

void Traffic::TrafficDataSource_Abstract::processXGPSString ( const QByteArray & data )

protected

Process one XGPS string.

This method expects exactly XGPS/XTRAFFIC string, as specified in

https://www.foreflight.com/support/network-gps/

The method interprets the string and updates the properties and emits signals as appropriate. Invalid messages are silently ignored.

Parameters

data	A QByteArray containing an XGPS string.

◆ receivingHeartbeat()

bool Traffic::TrafficDataSource_Abstract::receivingHeartbeat ( ) const

inlinenodiscard

Getter function for the property with the same name.

Returns: Property receivingHeartbeat

Definition at line 222 of file TrafficDataSource_Abstract.h.

◆ resetReceivingHeartbeat()

void Traffic::TrafficDataSource_Abstract::resetReceivingHeartbeat ( )

protected

Resetter method for the property with the same name.

This is equivalent to calling setReceivingHeartbeat(false)

◆ setConnectivityStatus()

void Traffic::TrafficDataSource_Abstract::setConnectivityStatus ( const QString & newConnectivityStatus )

protected

Setter function for the property with the same name.

Parameters

newConnectivityStatus Property connectivityStatus

◆ setErrorString()

void Traffic::TrafficDataSource_Abstract::setErrorString ( const QString & newErrorString = QString() )

protected

Setter function for the property with the same name.

Parameters

newErrorString Property errorString

◆ setPassword

virtual void Traffic::TrafficDataSource_Abstract::setPassword	(	const QString &	SSID,
		const QString &	password )

inlinevirtualslot

Set password.

If the implementation of the traffic data source supports passwords, this method checks if the traffic data source is waiting for a password with key SSID. If so, it will send the password to the traffic data receiver. If the implementation of the traffic data source does not support passwords, this method does nothing.

Definition at line 375 of file TrafficDataSource_Abstract.h.

◆ setPressureAltitude()

void Traffic::TrafficDataSource_Abstract::setPressureAltitude ( Units::Distance newPressureAltitude )

protected

Setter function for the property with the same name.

This method must be used by child classes to update the pressure altitude The class uses a timer internally to reset the position info to "invalid" after the time specified in PositionInfo::lifetime seconds.

Parameters

newPressureAltitude Pressure Altitude

◆ setReceivingHeartbeat()

void Traffic::TrafficDataSource_Abstract::setReceivingHeartbeat ( bool newReceivingHeartbeat )

protected

Setter method for the property with the same name.

When set to 'true' a timer is stated that will automatically reset the property to 'false' after 5 seconds of inactivity.

Parameters

newReceivingHeartbeat Property receivingHeartbeat

◆ setTrafficReceiverRuntimeError()

void Traffic::TrafficDataSource_Abstract::setTrafficReceiverRuntimeError ( const QString & newErrorString )

protected

Setter function for the property with the same name.

Parameters

newErrorString Property errorString

◆ setTrafficReceiverSelfTestError()

void Traffic::TrafficDataSource_Abstract::setTrafficReceiverSelfTestError ( const QString & newErrorString )

protected

Setter function for the property with the same name.

Parameters

newErrorString Property errorString

◆ sourceName()

virtual QString Traffic::TrafficDataSource_Abstract::sourceName ( ) const

nodiscardpure virtual

Getter function for the property with the same name.

Returns: Property sourceName

Implemented in Traffic::TrafficDataSource_BluetoothClassic, Traffic::TrafficDataSource_BluetoothLowEnergy, Traffic::TrafficDataSource_File, Traffic::TrafficDataSource_SerialPort, Traffic::TrafficDataSource_Simulate, Traffic::TrafficDataSource_Tcp, and Traffic::TrafficDataSource_Udp.

◆ trafficReceiverHwVersion

void Traffic::TrafficDataSource_Abstract::trafficReceiverHwVersion ( QString result )

signal

Traffic receiver hardware version.

If this class receives information about the hardware version of a connected traffic receiver, this information is emitted here.

Parameters

result String that identifies the hardware version

◆ trafficReceiverObVersion

void Traffic::TrafficDataSource_Abstract::trafficReceiverObVersion ( QString result )

signal

Traffic receiver obstacle database version.

If this class receives information about the obstacle database version of a connected traffic receiver, this information is emitted here.

Parameters

result String that identifies the obstacle database version

◆ trafficReceiverRuntimeError()

QString Traffic::TrafficDataSource_Abstract::trafficReceiverRuntimeError ( ) const

inlinenodiscard

Getter function for the property with the same name.

Returns: Property errorString

Definition at line 237 of file TrafficDataSource_Abstract.h.

◆ trafficReceiverSelfTestError()

QString Traffic::TrafficDataSource_Abstract::trafficReceiverSelfTestError ( ) const

inlinenodiscard

Getter function for the property with the same name.

Returns: Property errorString

Definition at line 246 of file TrafficDataSource_Abstract.h.

◆ trafficReceiverSwVersion

void Traffic::TrafficDataSource_Abstract::trafficReceiverSwVersion ( QString result )

signal

Traffic receiver software version.

If this class receives information about the software version of a connected traffic receiver, this information is emitted here.

Parameters

result String that identifies the software version

◆ warning

void Traffic::TrafficDataSource_Abstract::warning ( const Traffic::Warning & warning )

signal

Traffic warning.

This signal is emitted when the traffic receiver issues a traffic warning. An invalid warning (i.e. a warning with alarm level = -1) is emitted to indicate that the last warning is no longer active and should be disregarded.

Parameters

warning Traffic warning.

Property Documentation

◆ canonical

bool Traffic::TrafficDataSource_Abstract::canonical

read

Canonicity.

This property contains 'true' if the connection is a canonical connection that cannot be deleted.

Definition at line 68 of file TrafficDataSource_Abstract.h.

◆ connectionInfo

Traffic::ConnectionInfo Traffic::TrafficDataSource_Abstract::connectionInfo

read

Connection Info.

This property contains a connection info that can be used to save and restore this connection.

Definition at line 88 of file TrafficDataSource_Abstract.h.

◆ connectivityStatus

QString Traffic::TrafficDataSource_Abstract::connectivityStatus

readwrite

Connectivity status.

This property contains a human-readable, translated string that describes if the class has established a connection to a traffic receiver. A typical string could be "Bound to an address and port, but not connected yet.". Subclasses shall use the setter function to set the property content.

The setter method is protected and can be used by subclasses to update the property content.

Definition at line 81 of file TrafficDataSource_Abstract.h.

◆ dataFormat

QString Traffic::TrafficDataSource_Abstract::dataFormat

read

Data format.

This property contains a string of the form "FLARM/NMEA" or "GDL90 · XGPS".

Definition at line 94 of file TrafficDataSource_Abstract.h.

◆ errorString

QString Traffic::TrafficDataSource_Abstract::errorString

readwrite

String describing the last socket error.

This property holds a translated, human-readable string that describes the last error, or an empty string when there is not error. The string is cleared when a new connection attempt is started.

Definition at line 102 of file TrafficDataSource_Abstract.h.

◆ pressureAltitude

Units::Distance Traffic::TrafficDataSource_Abstract::pressureAltitude

read

Pressure altitude.

This property holds information about the pressure altitude, that is, the altitude that you would read off your altimeter if the altimeter is set to 1013.2 hPa. To ensure that the data is up-to-date, the position information will be set to "invalid" when no data has arrived for more than the time specified in PositionInfo::lifetime.

Definition at line 115 of file TrafficDataSource_Abstract.h.

◆ receivingHeartbeat

bool Traffic::TrafficDataSource_Abstract::receivingHeartbeat

readwrite

Heartbeat indicator.

When active, traffic receivers send regular heartbeat messages. These can be used to verify that the connection to the receiver works, even in times when no traffic is reported. This property indicates if the class receives heartbeat messages from at least one of the known receivers.

The setter and resetter methods are protected and can be used by subclasses to update the property content.

Definition at line 127 of file TrafficDataSource_Abstract.h.

◆ sourceName

QString Traffic::TrafficDataSource_Abstract::sourceName

read

Source name.

This property contains a short, human-readable and translated description of the source. A typical string is "TCP connection to 132.168.1.1 port 2000".

Definition at line 135 of file TrafficDataSource_Abstract.h.

◆ trafficReceiverRuntimeError

QString Traffic::TrafficDataSource_Abstract::trafficReceiverRuntimeError

readwrite

String describing the last traffic data receiver runtime error.

This property holds a translated, human-readable string that describes the last error reported by the traffic receiver, or an empty string when there is not error. The string is cleared when a new connection attempt is started.

Definition at line 144 of file TrafficDataSource_Abstract.h.

◆ trafficReceiverSelfTestError

QString Traffic::TrafficDataSource_Abstract::trafficReceiverSelfTestError

readwrite

String describing the last traffic data receiver self-test error.

This property holds a translated, human-readable string that describes the last error reported by the traffic receiver self-test, or an empty string when there is not error. The string is cleared when a new connection attempt is started.

Definition at line 153 of file TrafficDataSource_Abstract.h.

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

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

Public Slots

Signals

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ TrafficDataSource_Abstract()

Member Function Documentation

◆ bindablePressureAltitude()

◆ canonical()

◆ connectionInfo()

◆ connectivityStatus()

◆ connectToTrafficReceiver

◆ dataFormat()

◆ disconnectFromTrafficReceiver

◆ errorString()

◆ factorWithoutPosition

◆ factorWithPosition

◆ icon()

◆ positionUpdated

◆ pressureAltitude()

◆ processFLARMData()

◆ processGDLMessage()

◆ processXGPSString()

◆ receivingHeartbeat()

◆ resetReceivingHeartbeat()

◆ setConnectivityStatus()

◆ setErrorString()

◆ setPassword

◆ setPressureAltitude()

◆ setReceivingHeartbeat()

◆ setTrafficReceiverRuntimeError()

◆ setTrafficReceiverSelfTestError()

◆ sourceName()

◆ trafficReceiverHwVersion

◆ trafficReceiverObVersion

◆ trafficReceiverRuntimeError()

◆ trafficReceiverSelfTestError()

◆ trafficReceiverSwVersion

◆ warning

Property Documentation

◆ canonical

◆ connectionInfo

◆ connectivityStatus

◆ dataFormat

◆ errorString

◆ pressureAltitude

◆ receivingHeartbeat

◆ sourceName

◆ trafficReceiverRuntimeError

◆ trafficReceiverSelfTestError