Class PositioningSource

ClassList > PositioningSource

More...

• #include <positioningsource.h>

Inherits the following classes: QObject

Public Types

Type	Name
enum	ElevationCorrectionMode

Public Static Attributes

Type	Name
QString	backgroundFilePath = QStringLiteral( "%1/positioning.background" ).arg( QStandardPaths::writableLocation( QStandardPaths::AppDataLocation ) )

Public Slots

Type	Name
slot void	triggerConnectDevice
slot void	triggerDisconnectDevice

Public Properties

Type	Name
property bool	active
property double	antennaHeight
property bool	backgroundMode
property GnssPositionDetails	deviceDetails
property QString	deviceId
property QString	deviceLastError
property QAbstractSocket::SocketState	deviceSocketState
property QString	deviceSocketStateString
property ElevationCorrectionMode	elevationCorrectionMode
property bool	logging
property QString	loggingPath
property double	orientation
property GnssPositionInformation	positionInformation
property bool	valid

Public Signals

Type	Name
signal void	activeChanged
signal void	antennaHeightChanged
signal void	backgroundModeChanged
signal void	deviceChanged
signal void	deviceIdChanged
signal void	deviceLastErrorChanged
signal void	deviceSocketStateChanged
signal void	deviceSocketStateStringChanged
signal void	elevationCorrectionModeChanged
signal void	loggingChanged
signal void	loggingPathChanged
signal void	orientationChanged
signal void	positionInformationChanged
signal void	validChanged

Public Functions

Type	Name
	PositioningSource (QObject * parent=nullptr)
bool	active () const
double	antennaHeight () const
bool	backgroundMode () const
AbstractGnssReceiver *	device () const
GnssPositionDetails	deviceDetails () const
Q_INVOKABLE QString	deviceId () const
QString	deviceLastError () const
QAbstractSocket::SocketState	deviceSocketState () const
QString	deviceSocketStateString () const
ElevationCorrectionMode	elevationCorrectionMode () const
Q_INVOKABLE QList< GnssPositionInformation >	getBackgroundPositionInformation () const
bool	logging () const
QString	loggingPath () const
double	orientation () const
GnssPositionInformation	positionInformation () const
void	setActive (bool active)
void	setAntennaHeight (double antennaHeight)
void	setBackgroundMode (bool backgroundMode)
void	setDeviceId (const QString & id)
void	setElevationCorrectionMode (ElevationCorrectionMode elevationCorrectionMode)
void	setLogging (bool logging)
void	setLoggingPath (const QString & path)
void	setValid (bool valid)
bool	valid () const
virtual	~PositioningSource () = default

Detailed Description

This class connects to GNSS devices (internal or bluetooth NMEA) and provides positioning details.

Public Types Documentation

enum ElevationCorrectionMode

enum PositioningSource::ElevationCorrectionMode {
    None,
    OrthometricFromDevice,
    OrthometricFromGeoidFile
};

Elevation correction modes

---

Public Static Attributes Documentation

variable backgroundFilePath

QString PositioningSource::backgroundFilePath;

---

Public Properties Documentation

property active [1/2]

bool PositioningSource::active;

---

property antennaHeight [1/2]

double PositioningSource::antennaHeight;

---

property backgroundMode [1/2]

bool PositioningSource::backgroundMode;

---

property deviceDetails [1/2]

GnssPositionDetails PositioningSource::deviceDetails;

---

property deviceId [1/2]

QString PositioningSource::deviceId;

---

property deviceLastError [1/2]

QString PositioningSource::deviceLastError;

---

property deviceSocketState [1/2]

QAbstractSocket::SocketState PositioningSource::deviceSocketState;

---

property deviceSocketStateString [1/2]

QString PositioningSource::deviceSocketStateString;

---

property elevationCorrectionMode [1/2]

ElevationCorrectionMode PositioningSource::elevationCorrectionMode;

---

property logging [1/2]

bool PositioningSource::logging;

---

property loggingPath [1/2]

QString PositioningSource::loggingPath;

---

property orientation [1/2]

double PositioningSource::orientation;

---

property positionInformation [1/2]

GnssPositionInformation PositioningSource::positionInformation;

---

property valid [1/2]

bool PositioningSource::valid;

---

Public Slots Documentation

slot triggerConnectDevice

void PositioningSource::triggerConnectDevice;

---

slot triggerDisconnectDevice

void PositioningSource::triggerDisconnectDevice;

---

Public Signals Documentation

signal activeChanged

void PositioningSource::activeChanged;

---

signal antennaHeightChanged

void PositioningSource::antennaHeightChanged;

---

signal backgroundModeChanged

void PositioningSource::backgroundModeChanged;

---

signal deviceChanged

void PositioningSource::deviceChanged;

---

signal deviceIdChanged

void PositioningSource::deviceIdChanged;

---

signal deviceLastErrorChanged

void PositioningSource::deviceLastErrorChanged;

---

signal deviceSocketStateChanged

void PositioningSource::deviceSocketStateChanged;

---

signal deviceSocketStateStringChanged

void PositioningSource::deviceSocketStateStringChanged;

---

signal elevationCorrectionModeChanged

void PositioningSource::elevationCorrectionModeChanged;

---

signal loggingChanged

void PositioningSource::loggingChanged;

---

signal loggingPathChanged

void PositioningSource::loggingPathChanged;

---

signal orientationChanged

void PositioningSource::orientationChanged;

---

signal positionInformationChanged

void PositioningSource::positionInformationChanged;

---

signal validChanged

void PositioningSource::validChanged;

---

Public Functions Documentation

function PositioningSource

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

---

function active [2/2]

inline bool PositioningSource::active () const

Returns TRUE when positioning is active.

See also: setActive

---

function antennaHeight [2/2]

inline double PositioningSource::antennaHeight () const

Sets the GNSS device antenna height. This should be the pole height + sensore phase height.

Note:

When IMU is active this value is ignored as the device does the correction internally.

---

function backgroundMode [2/2]

inline bool PositioningSource::backgroundMode () const

Returns TRUE if the background mode is active. When activated, position information details will not be signaled but instead saved to disk until deactivated.

See also: getBackgroundPositionInformation()

---

function device

inline AbstractGnssReceiver * PositioningSource::device () const

Returns the current positioning device.

See also: deviceId

---

function deviceDetails [2/2]

inline GnssPositionDetails PositioningSource::deviceDetails () const

Returns extra details (such as hdop, vdop, pdop) provided by the positioning device.

---

function deviceId [2/2]

inline Q_INVOKABLE QString PositioningSource::deviceId () const

Returns the current positioning device id used to fetch position information.

See also: setDevice

---

function deviceLastError [2/2]

inline QString PositioningSource::deviceLastError () const

Returns positioning device's last error string.

---

function deviceSocketState [2/2]

inline QAbstractSocket::SocketState PositioningSource::deviceSocketState () const

Returns positioning device's socket state.

See also: deviceSocketStateString

---

function deviceSocketStateString [2/2]

inline QString PositioningSource::deviceSocketStateString () const

Returns a string representation of the positioning device's socket state.

See also: deviceSocketState

---

function elevationCorrectionMode [2/2]

inline ElevationCorrectionMode PositioningSource::elevationCorrectionMode () const

Returns the current elevation correction mode.

Note:

Some modes depends on device capabilities.

---

function getBackgroundPositionInformation

Q_INVOKABLE QList< GnssPositionInformation > PositioningSource::getBackgroundPositionInformation () const

Returns a list of position information collected while background mode is active.

See also: backgroundMode()

See also: setBackgroundMode()

---

function logging [2/2]

inline bool PositioningSource::logging () const

Returns whether GNSS devices will log their incoming position stream into a logfile.

Note:

Requires a device type with logging capability

---

function loggingPath [2/2]

inline QString PositioningSource::loggingPath () const

Returns the path where GNSS devices will log their incoming position stream into logfiles.

Note:

Requires a device type with logging capability

---

function orientation [2/2]

inline double PositioningSource::orientation () const

Returns the current device orientation

---

function positionInformation [2/2]

inline GnssPositionInformation PositioningSource::positionInformation () const

Returns a GnssPositionInformation position information object.

---

function setActive

void PositioningSource::setActive (
    bool active
) 

Sets the positioning active status.

See also: active

---

function setAntennaHeight

void PositioningSource::setAntennaHeight (
    double antennaHeight
) 

Returns the GNSS device antenna height. This should be the pole height + sensore phase height.

Note:

When IMU is active this value is ignored as the device does the correction internally.

---

function setBackgroundMode

void PositioningSource::setBackgroundMode (
    bool backgroundMode
) 

Sets whether the background mode is active. When activated, position information details will not be signaled but instead saved to disk until deactivated.

See also: getBackgroundPositionInformation()

---

function setDeviceId

void PositioningSource::setDeviceId (
    const QString & id
) 

Sets the positioning device id used to fetch position information.

Note:

A blank string will connect the internal positioning device; bluetooth addresses will trigger an NMEA connection to external devices.

---

function setElevationCorrectionMode

void PositioningSource::setElevationCorrectionMode (
    ElevationCorrectionMode elevationCorrectionMode
) 

Sets the current elevation correction mode.

Note:

Some modes depends on device capabilities.

---

function setLogging

void PositioningSource::setLogging (
    bool logging
) 

Sets whether GNSS devices will log their incoming position stream into a logfile.

Note:

Requires a device type with logging capability

---

function setLoggingPath

void PositioningSource::setLoggingPath (
    const QString & path
) 

Sets the path where GNSS devices will log their incoming position stream into logfiles.

Note:

Requires a device type with logging capability

---

function setValid

void PositioningSource::setValid (
    bool valid
) 

Sets whether the positioning device is valid.

---

function valid [2/2]

inline bool PositioningSource::valid () const

Returns TRUE when the positioning device is valid.

---

function ~PositioningSource

virtual PositioningSource::~PositioningSource () = default

---

---

The documentation for this class was generated from the following file src/core/positioning/positioningsource.h