Traffic::ConnectionScanner_Abstract Class Reference

Connection Scanner. More...

#include <ConnectionScanner_Abstract.h>

Inheritance diagram for Traffic::ConnectionScanner_Abstract:

Public Slots
virtual void	start ()=0
	Start scan process.
virtual void	stop ()=0
	Stop scan process.

Signals
void	connectionInfosChanged ()
	Notifier signal.
void	connectionDiscovered (const Traffic::ConnectionInfo &info)
	This signal to indicate whenever a device has been discovered.
void	errorChanged ()
	Notifier signal.
void	scanFinished ()
	Scan finished.
void	scanningChanged ()
	Notifier signal.

Public Member Functions
	ConnectionScanner_Abstract (QObject *parent=nullptr)
	Constructor.
QList< Traffic::ConnectionInfo >	connectionInfos () const
	Getter method for property with the same name.
QString	error () const
	Getter method for property with the same name.
bool	scanning () const
	Getter method for property with the same name.

Properties
QList< Traffic::ConnectionInfo >	connectionInfos
	List of device connections found in the scanning process.
QString	error
	Errors encountered during the scanning process.
bool	scanning
	Indicator if scan is in progress.

Detailed Description

Connection Scanner.

This is an abstract base class for classes that scan for potential connections to traffic data receivers and other devices.

Definition at line 35 of file ConnectionScanner_Abstract.h.

Constructor & Destructor Documentation

ConnectionScanner_Abstract()

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

explicit

Constructor.

This constructor does not start the scanning process.

Parameters

parent

The standard QObject parent pointer

Member Function Documentation

connectionDiscovered

void Traffic::ConnectionScanner_Abstract::connectionDiscovered ( const Traffic::ConnectionInfo & info )

signal

This signal to indicate whenever a device has been discovered.

This signal is emitted during the scan process. Consumers should expect that identical connections are emitted multiple times. This signal is emitted only if the connections looks like a connections to a traffic data receiver. The final list of connections might contain elements that have not been advertised via this signal.

connectionInfos()

QList< Traffic::ConnectionInfo > Traffic::ConnectionScanner_Abstract::connectionInfos ( ) const

inlinenodiscard

Getter method for property with the same name.

Returns

Property connectionInfos

Definition at line 78 of file ConnectionScanner_Abstract.h.

error()

QString Traffic::ConnectionScanner_Abstract::error ( ) const

inlinenodiscard

Getter method for property with the same name.

Returns

Property error

Definition at line 84 of file ConnectionScanner_Abstract.h.

scanFinished

void Traffic::ConnectionScanner_Abstract::scanFinished ( )

signal

Scan finished.

This signal is emitted once the scan is finished and the property devices() holds the final list .

scanning()

bool Traffic::ConnectionScanner_Abstract::scanning ( ) const

inlinenodiscard

Getter method for property with the same name.

Returns

Property scanning

Definition at line 90 of file ConnectionScanner_Abstract.h.

start

virtual void Traffic::ConnectionScanner_Abstract::start ( )

pure virtualslot

Start scan process.

This class will not start the scanning process automatically. Use this method to start. It is safe to call this method anytime.

stop

virtual void Traffic::ConnectionScanner_Abstract::stop ( )

pure virtualslot

Stop scan process.

This class will abort the running scanning process automatically. It is safe to call this method anytime.

Property Documentation

connectionInfos

QList<Traffic::ConnectionInfo> Traffic::ConnectionScanner_Abstract::connectionInfos

read

List of device connections found in the scanning process.

This property is typically updated multiple times during a scan process

Definition at line 57 of file ConnectionScanner_Abstract.h.

error

QString Traffic::ConnectionScanner_Abstract::error

read

Errors encountered during the scanning process.

This property holds an empty string in case of no error.

Definition at line 63 of file ConnectionScanner_Abstract.h.

---

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

• /home/runner/work/enroute/enroute/src/traffic/ConnectionScanner_Abstract.h