Traffic receiver: TCP connection to FLARM/NMEA source. More...

#include <TrafficDataSource_Tcp.h>

Inheritance diagram for Traffic::TrafficDataSource_Tcp:

Public Slots
void	connectToTrafficReceiver () override
	Start attempt to connect to traffic receiver.

void	disconnectFromTrafficReceiver () override
	Disconnect from traffic receiver.

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

Public Slots inherited from Traffic::TrafficDataSource_Abstract
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.

Public Member Functions
	TrafficDataSource_Tcp (bool isCanonical, QString hostName, quint16 port, QObject *parent=nullptr)
	Default constructor.

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

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

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

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

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

quint16	port () const
	Getter function for the property with the same name.

Public Member Functions inherited from Traffic::TrafficDataSource_AbstractSocket
	TrafficDataSource_AbstractSocket (bool isCanonical, QObject *parent)
	Default constructor.

Public Member Functions inherited from Traffic::TrafficDataSource_Abstract
	TrafficDataSource_Abstract (bool isCanonical, QObject *parent)
	Default constructor.

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

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

QString	errorString () const
	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.

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

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

Properties
QString	host
	Host.

quint16	port
	Port.

Properties inherited from Traffic::TrafficDataSource_Abstract
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.

Additional Inherited Members
Signals inherited from Traffic::TrafficDataSource_Abstract
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.

Protected Member Functions inherited from Traffic::TrafficDataSource_Abstract
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.

Detailed Description

Traffic receiver: TCP connection to FLARM/NMEA source.

This class connects to a traffic receiver via a TCP connection. It expects to find a receiver at the specifed IP-Address and port that emits FLARM/NMEA sentences.

In most use cases, the connection will be established via the device's WiFi interface. The class will therefore try to lock the WiFi once a heartbeat has been detected, and release the WiFi at the appropriate time.

Definition at line 44 of file TrafficDataSource_Tcp.h.

Constructor & Destructor Documentation

◆ TrafficDataSource_Tcp()

Traffic::TrafficDataSource_Tcp::TrafficDataSource_Tcp	(	bool	isCanonical,
		QString	hostName,
		quint16	port,
		QObject *	parent = nullptr )

Default constructor.

Parameters

isCanonical	Intializer for property canonical
hostName	Name of the host where the traffic receiver is expected
port	Port at the host where the traffic receiver is expected
parent	The standard QObject parent pointer

Member Function Documentation

◆ connectionInfo()

Traffic::ConnectionInfo Traffic::TrafficDataSource_Tcp::connectionInfo ( ) const

inlinenodiscardoverridevirtual

Getter function for the property with the same name.

Returns: Property connectionInfo

Reimplemented from Traffic::TrafficDataSource_Abstract.

Definition at line 87 of file TrafficDataSource_Tcp.h.

◆ connectToTrafficReceiver

void Traffic::TrafficDataSource_Tcp::connectToTrafficReceiver ( )

overrideslot

Start attempt to connect to traffic receiver.

This method implements the pure virtual method declared by its superclass.

◆ dataFormat()

QString Traffic::TrafficDataSource_Tcp::dataFormat ( ) const

inlinenodiscardoverridevirtual

Getter function for the property with the same name.

Returns: Property dataFormat

Implements Traffic::TrafficDataSource_Abstract.

Definition at line 93 of file TrafficDataSource_Tcp.h.

◆ disconnectFromTrafficReceiver

void Traffic::TrafficDataSource_Tcp::disconnectFromTrafficReceiver ( )

overrideslot

Disconnect from traffic receiver.

This method implements the pure virtual method declared by its superclass.

◆ host()

QString Traffic::TrafficDataSource_Tcp::host ( ) const

inlinenodiscard

Getter function for the property with the same name.

Returns: Property host

Definition at line 99 of file TrafficDataSource_Tcp.h.

◆ icon()

QString Traffic::TrafficDataSource_Tcp::icon ( ) const

inlinenodiscardoverridevirtual

Getter function for the property with the same name.

This method implements the pure virtual method declared by its superclass.

Returns: Property icon

Implements Traffic::TrafficDataSource_Abstract.

Definition at line 111 of file TrafficDataSource_Tcp.h.

◆ port()

quint16 Traffic::TrafficDataSource_Tcp::port ( ) const

inlinenodiscard

Getter function for the property with the same name.

Returns: Property port

Definition at line 129 of file TrafficDataSource_Tcp.h.

◆ setPassword

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

overrideslot

Set password.

This method implements the pure virtual method declared by its superclass.

◆ sourceName()

auto Traffic::TrafficDataSource_Tcp::sourceName ( ) const -> QString

inlinenodiscardoverridevirtual

Getter function for the property with the same name.

This method implements the pure virtual method declared by its superclass.

Returns: Property sourceName

Implements Traffic::TrafficDataSource_Abstract.

Definition at line 120 of file TrafficDataSource_Tcp.h.

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

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

Public Slots

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TrafficDataSource_Tcp()

Member Function Documentation

◆ connectionInfo()

◆ connectToTrafficReceiver

◆ dataFormat()

◆ disconnectFromTrafficReceiver

◆ host()

◆ icon()

◆ port()

◆ setPassword

◆ sourceName()