\inmodule QtPositioning More...

#include <qnmeasatelliteinfosource.h>

Inheritance diagram for QNmeaSatelliteInfoSource:

Collaboration diagram for QNmeaSatelliteInfoSource:

Public Types
enum class	UpdateMode { RealTimeMode = 1 , SimulationMode }
	Defines the available update modes. More...

Public Types inherited from QGeoSatelliteInfoSource
enum	Error { AccessError = 0 , ClosedError = 1 , NoError = 2 , UnknownSourceError = -1 , UpdateTimeoutError = 3 }
	The Error enumeration represents the errors which can occur. More...

Public Slots
void	startUpdates () override
	\reimp

void	stopUpdates () override
	\reimp

void	requestUpdate (int timeout=0) override
	\reimp

Public Slots inherited from QGeoSatelliteInfoSource
virtual void	startUpdates ()=0
	Starts emitting updates at regular intervals.

virtual void	stopUpdates ()=0
	Stops emitting updates at regular intervals.

virtual void	requestUpdate (int timeout=0)=0
	Attempts to get the current satellite information and emit satellitesInViewUpdated() and satellitesInUseUpdated() with this information.

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Public Member Functions
	QNmeaSatelliteInfoSource (UpdateMode mode, QObject *parent=nullptr)
	Constructs a \l QNmeaSatelliteInfoSource instance with the given parent and mode.

	~QNmeaSatelliteInfoSource () override
	Destroys the satellite information source.

UpdateMode	updateMode () const
	Returns the update mode.

void	setDevice (QIODevice *source)
	Sets the NMEA data source to device.

QIODevice *	device () const
	Returns the NMEA data source.

void	setUpdateInterval (int msec) override
	\reimp

int	minimumUpdateInterval () const override
	\reimp

Error	error () const override
	\reimp

bool	setBackendProperty (const QString &name, const QVariant &value) override
	\reimp

QVariant	backendProperty (const QString &name) const override
	\reimp

Public Member Functions inherited from QGeoSatelliteInfoSource
	QGeoSatelliteInfoSource (QObject *parent)

virtual	~QGeoSatelliteInfoSource ()
	Destroys the satellite source.

QString	sourceName () const
	Returns the unique name of the satellite source implementation in use.

int	updateInterval () const

QBindable< int >	bindableUpdateInterval ()

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.

virtual	~QObject ()
	Destroys the object, deleting all its child objects.

virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.

virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.

QString	objectName () const

Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.

void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.

bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.

bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.

bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.

bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).

QThread *	thread () const
	Returns the thread in which the object lives.

bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.

int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

void	killTimer (Qt::TimerId id)

template<typename T>
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.

template<typename T>
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.

template<typename T>
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<typename T>
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const QObjectList &	children () const
	Returns a list of child objects.

void	setParent (QObject *parent)
	Makes the object a child of parent.

void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.

void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const
	Dumps a tree of children to the debug output.

void	dumpObjectInfo () const
	Dumps information about signal connections, etc.

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.

bool	setProperty (const char *name, QVariant &&value)

QVariant	property (const char *name) const
	Returns the value of the object's name property.

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const
	Returns a pointer to the parent object.

bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Static Public Attributes
static QString	SimulationUpdateInterval
	\variable QNmeaSatelliteInfoSource::SimulationUpdateInterval

Protected Types
enum	SatelliteInfoParseStatus { NotParsed = 0 , PartiallyParsed , FullyParsed }
	Defines the parse status of satellite information. More...

Protected Member Functions
QGeoSatelliteInfo::SatelliteSystem	parseSatellitesInUseFromNmea (QByteArrayView data, QList< int > &pnrsInUse)
	Parses an NMEA sentence string to extract the IDs of satelites in use.

SatelliteInfoParseStatus	parseSatelliteInfoFromNmea (QByteArrayView data, QList< QGeoSatelliteInfo > &infos, QGeoSatelliteInfo::SatelliteSystem &system)
	Parses an NMEA sentence string to extract the information about satellites in view.

void	setError (QGeoSatelliteInfoSource::Error satelliteError)

Protected Member Functions inherited from QGeoSatelliteInfoSource
	QGeoSatelliteInfoSource (QGeoSatelliteInfoSourcePrivate &dd, QObject *parent)

Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.

int	senderSignalIndex () const

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.

virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.

virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Protected Attributes
QNmeaSatelliteInfoSourcePrivate *	d

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Friends
class	QNmeaSatelliteInfoSourcePrivate

class	QLocationUtils

Additional Inherited Members
Signals inherited from QGeoSatelliteInfoSource
void	satellitesInViewUpdated (const QList< QGeoSatelliteInfo > &satellites)
	If startUpdates() or requestUpdate() is called, this signal is emitted when an update is available on the satellites that are currently in view.

void	satellitesInUseUpdated (const QList< QGeoSatelliteInfo > &satellites)
	If startUpdates() or requestUpdate() is called, this signal is emitted when an update is available on the number of satellites that are currently in use.

void	errorOccurred (QGeoSatelliteInfoSource::Error)
	This signal is emitted after an error occurred.

Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.

void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Static Public Member Functions inherited from QGeoSatelliteInfoSource
static QGeoSatelliteInfoSource *	createDefaultSource (QObject *parent)
	Creates and returns a source with the specified parent that reads from the system's default source of satellite update information, or the highest priority available plugin.

static QGeoSatelliteInfoSource *	createSource (const QString &sourceName, QObject *parent)
	Creates and returns a source with the given parent, by loading the plugin named sourceName.

static QGeoSatelliteInfoSource *	createDefaultSource (const QVariantMap &parameters, QObject *parent)
	Creates and returns a satellite source with the given parent that reads from the system's default sources of satellite data, or the plugin with the highest available priority.

static QGeoSatelliteInfoSource *	createSource (const QString &sourceName, const QVariantMap &parameters, QObject *parent)
	Creates and returns a satellite source with the given parent, by loading the plugin named sourceName.

static QStringList	availableSources ()
	Returns a list of available source plugins, including the default system backend if one is available.

Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe

static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1, typename Func2>
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.

template<typename Func1, typename Func2>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1>
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Properties inherited from QGeoSatelliteInfoSource
int	updateInterval
	This property holds the requested interval in milliseconds between each update.

int	minimumUpdateInterval
	This property holds the minimum time (in milliseconds) required to retrieve a satellite update.

Properties inherited from QObject
QString	objectName
	the name of this object

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

\inmodule QtPositioning

Since: 6.2

The \l QNmeaSatelliteInfoSource class provides satellite information using an NMEA data source.

NMEA is a commonly used protocol for the specification of one's global position at a certain point in time. The \l QNmeaSatelliteInfoSource class reads NMEA data and uses it to provide information about satellites in view and satellites in use in form of lists of \l QGeoSatelliteInfo objects.

A \l QNmeaSatelliteInfoSource instance operates in either \l {RealTimeMode} or \l {SimulationMode}. These modes allow NMEA data to be read from either a live source of data, or replayed for simulation purposes from previously recorded NMEA data.

The source of NMEA data is set via \l setDevice().

Use \l startUpdates() to start receiving regular satellite information updates and \l stopUpdates() to stop these updates. If you only require updates occasionally, you can call \l requestUpdate() to request a single update of both satellites in view and satellites in use.

The information about satellites in view is received via the \l satellitesInViewUpdated() signal.

The information about satellites in use is received via the \l satellitesInUseUpdated() signal.

Definition at line 13 of file qnmeasatelliteinfosource.h.

Member Enumeration Documentation

◆ SatelliteInfoParseStatus

enum QNmeaSatelliteInfoSource::SatelliteInfoParseStatus

protected

Defines the parse status of satellite information.

The satellite information can be split into multiple sentences, and we need to parse all of them. \value NotParsed The data does not contain information about satellites. \value PartiallyParsed A valid satellite information is received and parsed, but it's not complete, so we need to wait for another NMEA sentence. \value FullyParsed Satellite information was fully collected and parsed.

Enumerator
NotParsed
PartiallyParsed
FullyParsed

Definition at line 53 of file qnmeasatelliteinfosource.h.

◆ UpdateMode

enum class QNmeaSatelliteInfoSource::UpdateMode

strong

Defines the available update modes.

\value RealTimeMode Satellite information is read and distributed from the data source as it becomes available. Use this mode if you are using a live source of NMEA data (for example a GPS hardware device). \value SimulationMode Satellite information is read and distributed from the data source at the given rate. The rate is determined by the \l {QNmeaSatelliteInfoSource::}{SimulationUpdateInterval} parameter. Use this mode if the data source contains previously recorded NMEA data and you want to replay the data for simulation purposes.

Enumerator
RealTimeMode
SimulationMode

Definition at line 17 of file qnmeasatelliteinfosource.h.

Constructor & Destructor Documentation

◆ QNmeaSatelliteInfoSource()

QNmeaSatelliteInfoSource::QNmeaSatelliteInfoSource	(	UpdateMode	mode,
		QObject *	parent = nullptr )

explicit

Constructs a \l QNmeaSatelliteInfoSource instance with the given parent and mode.

Definition at line 410 of file qnmeasatelliteinfosource.cpp.

◆ ~QNmeaSatelliteInfoSource()

QNmeaSatelliteInfoSource::~QNmeaSatelliteInfoSource ( )

override

Destroys the satellite information source.

Definition at line 419 of file qnmeasatelliteinfosource.cpp.

Member Function Documentation

◆ backendProperty()

QVariant QNmeaSatelliteInfoSource::backendProperty ( const QString & name ) const

overridevirtual

\reimp

Reimplemented from QGeoSatelliteInfoSource.

Definition at line 518 of file qnmeasatelliteinfosource.cpp.

◆ device()

QIODevice * QNmeaSatelliteInfoSource::device ( ) const

Returns the NMEA data source.

Definition at line 457 of file qnmeasatelliteinfosource.cpp.

◆ error()

QGeoSatelliteInfoSource::Error QNmeaSatelliteInfoSource::error ( ) const

overridevirtual

\reimp

Implements QGeoSatelliteInfoSource.

Definition at line 488 of file qnmeasatelliteinfosource.cpp.

◆ minimumUpdateInterval()

int QNmeaSatelliteInfoSource::minimumUpdateInterval ( ) const

overridevirtual

\reimp

Implements QGeoSatelliteInfoSource.

Definition at line 480 of file qnmeasatelliteinfosource.cpp.

◆ parseSatelliteInfoFromNmea()

QNmeaSatelliteInfoSource::SatelliteInfoParseStatus QNmeaSatelliteInfoSource::parseSatelliteInfoFromNmea	(	QByteArrayView	data,
		QList< QGeoSatelliteInfo > &	infos,
		QGeoSatelliteInfo::SatelliteSystem &	system )

protected

Parses an NMEA sentence string to extract the information about satellites in view.

The default implementation will parse standard NMEA $GPGSV sentences. This method should be reimplemented in a subclass whenever the need to deal with non-standard NMEA sentences arises.

The parser reads size bytes from data and uses that information to fill infos list.

Returns \l SatelliteInfoParseStatus with parse result. Modifies infos list in case \l {QNmeaSatelliteInfoSource::} {PartiallyParsed} or \l {QNmeaSatelliteInfoSource::}{FullyParsed} is returned. Also sets the system to correct satellite system type. This is required to determine the system type in case there are no satellites in view.

Definition at line 637 of file qnmeasatelliteinfosource.cpp.

◆ parseSatellitesInUseFromNmea()

QGeoSatelliteInfo::SatelliteSystem QNmeaSatelliteInfoSource::parseSatellitesInUseFromNmea	(	QByteArrayView	data,
		QList< int > &	pnrsInUse )

protected

Parses an NMEA sentence string to extract the IDs of satelites in use.

The default implementation will parse standard NMEA $GPGSA sentences. This method should be reimplemented in a subclass whenever the need to deal with non-standard NMEA sentences arises.

The parser reads size bytes from data and uses that information to fill pnrsInUse list.

Returns system type if the sentence was successfully parsed, otherwise returns \l QGeoSatelliteInfo::Undefined and should not modifiy pnrsInUse.

Definition at line 582 of file qnmeasatelliteinfosource.cpp.

◆ requestUpdate

void QNmeaSatelliteInfoSource::requestUpdate ( int timeout = 0 )

overrideslot

\reimp

Definition at line 549 of file qnmeasatelliteinfosource.cpp.

◆ setBackendProperty()

bool QNmeaSatelliteInfoSource::setBackendProperty	(	const QString &	name,
		const QVariant &	value )

overridevirtual

\reimp

Reimplemented from QGeoSatelliteInfoSource.

Definition at line 496 of file qnmeasatelliteinfosource.cpp.

◆ setDevice()

void QNmeaSatelliteInfoSource::setDevice ( QIODevice * device )

Sets the NMEA data source to device.

If the device is not open, it will be opened in \l{QIODeviceBase::}{ReadOnly} mode.

The source device can only be set once and must be set before calling \l startUpdates() or \l requestUpdate().

Note: The device must emit \l {QIODevice::readyRead()} for the source to be notified when data is available for reading. \l QNmeaSatelliteInfoSource does not assume the ownership of the device, and hence does not deallocate it upon destruction.

Definition at line 444 of file qnmeasatelliteinfosource.cpp.

◆ setError()

void QNmeaSatelliteInfoSource::setError ( QGeoSatelliteInfoSource::Error satelliteError )

protected

Definition at line 649 of file qnmeasatelliteinfosource.cpp.

◆ setUpdateInterval()

void QNmeaSatelliteInfoSource::setUpdateInterval ( int msec )

overridevirtual

\reimp

Reimplemented from QGeoSatelliteInfoSource.

Definition at line 465 of file qnmeasatelliteinfosource.cpp.

◆ startUpdates

void QNmeaSatelliteInfoSource::startUpdates ( )

overrideslot

\reimp

Definition at line 533 of file qnmeasatelliteinfosource.cpp.

◆ stopUpdates

void QNmeaSatelliteInfoSource::stopUpdates ( )

overrideslot

\reimp

Definition at line 541 of file qnmeasatelliteinfosource.cpp.

◆ updateMode()

QNmeaSatelliteInfoSource::UpdateMode QNmeaSatelliteInfoSource::updateMode ( ) const

Returns the update mode.

Definition at line 427 of file qnmeasatelliteinfosource.cpp.

Friends And Related Symbol Documentation

◆ QLocationUtils

friend class QLocationUtils

friend

Definition at line 76 of file qnmeasatelliteinfosource.h.

◆ QNmeaSatelliteInfoSourcePrivate

friend class QNmeaSatelliteInfoSourcePrivate

friend

Definition at line 72 of file qnmeasatelliteinfosource.h.

Member Data Documentation

◆ d

QNmeaSatelliteInfoSourcePrivate* QNmeaSatelliteInfoSource::d

protected

Definition at line 69 of file qnmeasatelliteinfosource.h.

◆ SimulationUpdateInterval

QString QNmeaSatelliteInfoSource::SimulationUpdateInterval

static

Initial value:

=

QStringLiteral("nmea.satellite_info_simulation_interval")

QStringLiteral

#define QStringLiteral(str)

Definition qstringliteral.h:36

\variable QNmeaSatelliteInfoSource::SimulationUpdateInterval

The backend property name for data read rate in the \l SimulationMode. The value for this property is the integer number representing the amount of milliseconds between the subsequent reads. Use this parameter in the \l {QNmeaSatelliteInfoSource::} {setBackendProperty()} and \l {QNmeaSatelliteInfoSource::}{backendProperty()} methods.

Note: This property is different from the interval that can be set via \l {setUpdateInterval()}. The value set via \l {setUpdateInterval()} denotes an interval for the user notification, while this parameter specifies the internal frequency of reading the data from source file. It means that one can have multiple (or none) reads during the \l {updateInterval()} period.

Definition at line 22 of file qnmeasatelliteinfosource.h.

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

qtpositioning/src/positioning/qnmeasatelliteinfosource.h (edddb33b6966f9e8f8bd6de5cd40b5d7cac32e09)
qtpositioning/src/positioning/qnmeasatelliteinfosource.cpp (6b0c495b569af23d19c409df7c0a13b5d0f00fc4)

Public Types

Public Slots

Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ SatelliteInfoParseStatus

◆ UpdateMode

Constructor & Destructor Documentation

◆ QNmeaSatelliteInfoSource()

◆ ~QNmeaSatelliteInfoSource()

Member Function Documentation

◆ backendProperty()

◆ device()

◆ error()

◆ minimumUpdateInterval()

◆ parseSatelliteInfoFromNmea()

◆ parseSatellitesInUseFromNmea()

◆ requestUpdate

◆ setBackendProperty()

◆ setDevice()

◆ setError()

◆ setUpdateInterval()

◆ startUpdates

◆ stopUpdates

◆ updateMode()

Friends And Related Symbol Documentation

◆ QLocationUtils

◆ QNmeaSatelliteInfoSourcePrivate

Member Data Documentation

◆ d

◆ SimulationUpdateInterval