QGIS API Documentation 3.34.0-Prizren (ffbdd678812)
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
QgsUdpSocketSensor Class Reference

A UDP socket sensor class. More...

#include <qgsiodevicesensor.h>

Inheritance diagram for QgsUdpSocketSensor:
Inheritance graph
[legend]

Public Member Functions

 QgsUdpSocketSensor (QObject *parent=nullptr)
 Constructor for a UDP socket sensor, bound to the specified parent.
 
 ~QgsUdpSocketSensor () override=default
 
QString hostName () const
 Returns the host name the socket connects to.
 
int port () const
 Returns the port the socket connects to.
 
bool readPropertiesFromElement (const QDomElement &element, const QDomDocument &document) override
 Restores specific sensor type properties from a DOM element.
 
void setHostName (const QString &hostName)
 Sets the host name the socket connects to.
 
void setPort (int port)
 Sets the port the socket connects to.
 
QString type () const override
 Returns the sensor type.
 
bool writePropertiesToElement (QDomElement &element, QDomDocument &document) const override
 Write specific sensor type properties into a DOM element.
 
- Public Member Functions inherited from QgsIODeviceSensor
 QgsIODeviceSensor (QObject *parent=nullptr)
 Constructor for a abstract QIODevice-based sensor, bound to the specified parent.
 
 ~QgsIODeviceSensor () override
 
QIODevice * iODevice () const
 Returns the I/O device.
 
- Public Member Functions inherited from QgsAbstractSensor
 QgsAbstractSensor (QObject *parent=nullptr)
 Constructor for an abstract sensor, bound to the specified parent.
 
virtual ~QgsAbstractSensor ()=default
 
void connectSensor ()
 Connects the sensor to its source.
 
QgsAbstractSensor::SensorData data () const
 Returns the latest captured data from the sensor.
 
void disconnectSensor ()
 Disconnects the sensor from its source.
 
QString errorString () const
 Returns the last error message.
 
QString id () const
 Returns the sensor ID.
 
QString name () const
 Returns the user-friendly name identifying the sensor.
 
bool readXml (const QDomElement &element, const QDomDocument &document)
 Restores generic sensor details from a DOM element.
 
void setData (const QgsAbstractSensor::SensorData &data)
 Sets the latest captured data from the sensor.
 
void setName (const QString &name)
 Sets the user-friendly name identfying the sensor.
 
void setStatus (Qgis::DeviceConnectionStatus status)
 Sets the current sensor status.
 
Qgis::DeviceConnectionStatus status () const
 Returns the current sensor status.
 
bool writeXml (QDomElement &parentElement, QDomDocument &document) const
 Write generic sensor properties into a DOM element.
 

Static Public Member Functions

static QgsUdpSocketSensorcreate (QObject *parent)
 Returns a new UDP socket sensor.
 

Protected Member Functions

void handleConnect () override
 Handles the connection to the sensor.
 
void handleDisconnect () override
 Handles the disconnection from the sensor.
 
- Protected Member Functions inherited from QgsIODeviceSensor
void initIODevice (QIODevice *device)
 Initiates the I/O device.
 

Additional Inherited Members

- Signals inherited from QgsAbstractSensor
void dataChanged ()
 Emitted when the captured sensor data has changed.
 
void errorOccurred (const QString &errorString)
 Emitted when an error has occurred. The errorString describes the error.
 
void nameChanged ()
 Emitted when the sensor name has changed.
 
void statusChanged ()
 Emitted when the sensor status has changed.
 
- Protected Slots inherited from QgsIODeviceSensor
virtual void parseData ()
 Parses the data read from the device when available.
 
- Protected Attributes inherited from QgsAbstractSensor
QgsAbstractSensor::SensorData mData
 
QString mErrorString
 

Detailed Description

A UDP socket sensor class.

Since
QGIS 3.32

Definition at line 156 of file qgsiodevicesensor.h.

Constructor & Destructor Documentation

◆ QgsUdpSocketSensor()

QgsUdpSocketSensor::QgsUdpSocketSensor ( QObject *  parent = nullptr)
explicit

Constructor for a UDP socket sensor, bound to the specified parent.

Definition at line 180 of file qgsiodevicesensor.cpp.

◆ ~QgsUdpSocketSensor()

QgsUdpSocketSensor::~QgsUdpSocketSensor ( )
overridedefault

Member Function Documentation

◆ create()

QgsUdpSocketSensor * QgsUdpSocketSensor::create ( QObject *  parent)
static

Returns a new UDP socket sensor.

The caller takes responsibility for deleting the returned object.

Definition at line 218 of file qgsiodevicesensor.cpp.

◆ handleConnect()

void QgsUdpSocketSensor::handleConnect ( )
overrideprotectedvirtual

Handles the connection to the sensor.

Note
Triggered by calling connectSensor()

Implements QgsAbstractSensor.

Definition at line 254 of file qgsiodevicesensor.cpp.

◆ handleDisconnect()

void QgsUdpSocketSensor::handleDisconnect ( )
overrideprotectedvirtual

Handles the disconnection from the sensor.

Note
Triggered by calling disconnectSensor()

Implements QgsAbstractSensor.

Definition at line 267 of file qgsiodevicesensor.cpp.

◆ hostName()

QString QgsUdpSocketSensor::hostName ( ) const

Returns the host name the socket connects to.

Definition at line 228 of file qgsiodevicesensor.cpp.

◆ port()

int QgsUdpSocketSensor::port ( ) const

Returns the port the socket connects to.

Definition at line 241 of file qgsiodevicesensor.cpp.

◆ readPropertiesFromElement()

bool QgsUdpSocketSensor::readPropertiesFromElement ( const QDomElement &  element,
const QDomDocument &  document 
)
overridevirtual

Restores specific sensor type properties from a DOM element.

Parameters
elementDOM node corresponding to item (e.g. 'Sensor' element)
documentDOM document

Reimplemented from QgsAbstractSensor.

Definition at line 322 of file qgsiodevicesensor.cpp.

◆ setHostName()

void QgsUdpSocketSensor::setHostName ( const QString &  hostName)

Sets the host name the socket connects to.

Parameters
hostNamethe host name string (a domain name or an IP address)

Definition at line 233 of file qgsiodevicesensor.cpp.

◆ setPort()

void QgsUdpSocketSensor::setPort ( int  port)

Sets the port the socket connects to.

Definition at line 246 of file qgsiodevicesensor.cpp.

◆ type()

QString QgsUdpSocketSensor::type ( ) const
overridevirtual

Returns the sensor type.

This will match the type string of the sensor class, as used by QgsSensorRegistry.

Reimplemented from QgsAbstractSensor.

Definition at line 223 of file qgsiodevicesensor.cpp.

◆ writePropertiesToElement()

bool QgsUdpSocketSensor::writePropertiesToElement ( QDomElement &  element,
QDomDocument &  document 
) const
overridevirtual

Write specific sensor type properties into a DOM element.

Parameters
elementDOM node corresponding to item (e.g. 'Sensor' element)
documentDOM document

Reimplemented from QgsAbstractSensor.

Definition at line 314 of file qgsiodevicesensor.cpp.


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