NDEVR
API Documentation
GPSWidget

A composite GPS widget that combines a settings button, status display, and take-reading functionality for collecting GNSS position and orientation data. More...

Collaboration diagram for GPSWidget:
[legend]

Public Member Functions

 GPSWidget (const UUID &active_sensor, QWidget *parent=nullptr)
 Constructs the GPS widget for a sensor identified by UUID.
 GPSWidget (GPSSensor *sensor, QWidget *parent=nullptr)
 Constructs the GPS widget for a specific GPS sensor.
 GPSWidget (QWidget *parent=nullptr)
 Constructs the GPS widget with no sensor.
virtual ~GPSWidget ()
 Destructor.
GPSPoint currentGPS () const
 Returns the current GPS point data.
Vertex< 3, fltp08currentLocation () const
 Returns the current 3D location from the GPS sensor.
void newGPSChosenSignal ()
 Emitted when a new GPS sensor is chosen.
GNSSQualitySettings qualitySettings () const
 Returns the current quality settings for readings.
void readingTakenSignal (TakeReadingData data) const
 Emitted when a reading has been taken with the accumulated data.
GPSSensorsensor () const
 Returns the associated GPS sensor.
void setSensor (const UUID &active_sensor)
 Sets the sensor by UUID.
void setSensor (GPSSensor *sensor)
 Sets the GPS sensor to use.
void setTakeLocationReading (bool value)
 Sets whether to take location readings.
void setTakeOrientationReading (bool value)
 Sets whether to take orientation readings.
void updatedSignal ()
 Emitted when the sensor data is updated.

Protected Member Functions

void init ()
 Initializes the widget layout and sub-widgets.
void updatedSlot ()
 Slot called when the sensor data is updated.
void updateReadingSlot ()
 Slot called to update the take-reading accumulation.

Protected Attributes

UUID m_active_sensor = Constant<UUID>::Invalid
 The UUID of the active sensor.
GNSSOpenSettingsButtonm_gps_settings_button = nullptr
 Button to open GPS settings.
GPSSensorm_sensor = nullptr
 The GPS sensor instance.
bool m_take_location_reading = true
 Whether location readings are enabled.
bool m_take_orientation_reading = false
 Whether orientation readings are enabled.
Buttonm_take_reading_button = nullptr
 Button to start/stop taking a reading.
TakeReadingData m_take_reading_data
 Current take-reading accumulation state.

Detailed Description

A composite GPS widget that combines a settings button, status display, and take-reading functionality for collecting GNSS position and orientation data.

Definition at line 151 of file GPSWidget.h.

Constructor & Destructor Documentation

◆ GPSWidget() [1/3]

GPSWidget::GPSWidget ( QWidget * parent = nullptr)
explicit

Constructs the GPS widget with no sensor.

Parameters
[in]parentOptional parent widget.

◆ GPSWidget() [2/3]

GPSWidget::GPSWidget ( const UUID & active_sensor,
QWidget * parent = nullptr )
explicit

Constructs the GPS widget for a sensor identified by UUID.

Parameters
[in]active_sensorThe sensor UUID.
[in]parentOptional parent widget.

◆ GPSWidget() [3/3]

GPSWidget::GPSWidget ( GPSSensor * sensor,
QWidget * parent = nullptr )
explicit

Constructs the GPS widget for a specific GPS sensor.

Parameters
[in]sensorThe GPS sensor.
[in]parentOptional parent widget.

References sensor().

Member Function Documentation

◆ currentGPS()

GPSPoint GPSWidget::currentGPS ( ) const

Returns the current GPS point data.

Returns
The current GPS point.

◆ currentLocation()

Vertex< 3, fltp08 > GPSWidget::currentLocation ( ) const

Returns the current 3D location from the GPS sensor.

Returns
The current location vertex.

◆ qualitySettings()

GNSSQualitySettings GPSWidget::qualitySettings ( ) const

Returns the current quality settings for readings.

Returns
The GNSS quality settings.

◆ readingTakenSignal()

void GPSWidget::readingTakenSignal ( TakeReadingData data) const

Emitted when a reading has been taken with the accumulated data.

Parameters
[in]dataThe take-reading data.

◆ sensor()

GPSSensor * GPSWidget::sensor ( ) const

Returns the associated GPS sensor.

Returns
Pointer to the GPS sensor.

Referenced by GPSWidget(), and setSensor().

◆ setSensor() [1/2]

void GPSWidget::setSensor ( const UUID & active_sensor)

Sets the sensor by UUID.

Parameters
[in]active_sensorThe sensor UUID.

◆ setSensor() [2/2]

void GPSWidget::setSensor ( GPSSensor * sensor)

Sets the GPS sensor to use.

Parameters
[in]sensorThe GPS sensor.

References sensor().

◆ setTakeLocationReading()

void GPSWidget::setTakeLocationReading ( bool value)

Sets whether to take location readings.

Parameters
[in]valueTrue to enable location readings.

◆ setTakeOrientationReading()

void GPSWidget::setTakeOrientationReading ( bool value)

Sets whether to take orientation readings.

Parameters
[in]valueTrue to enable orientation readings.

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