QGeoSatelliteInfoSource

#include <QtLocationSubset/QGeoSatelliteInfoSource>

The QGeoSatelliteInfoSource class is an abstract base class for the distribution of satellite information updates.

QtLocationSubset

Since:

1.0

The static function QGeoSatelliteInfoSource::createDefaultSource() creates a default satellite data source that is appropriate for the platform, if one is available. Otherwise, available QGeoPositionInfoSourceFactory plugins will be checked for one that has a satellite data source available.

Call startUpdates() and stopUpdates() to start and stop regular updates, or requestUpdate() to request a single update. When an update is available, satellitesInViewUpdated() and/or satellitesInUseUpdated() will be emitted.

Users of a BlackBerry QGeoSatelliteInfoSource subclass (obtained from QGeoSatelliteInfoSource::createDefaultSource()) can access the underlying backend (BlackBerry Location Manager) for additional functionality via the Qt property system.

The following properties extend QGeoSatelliteInfoSource allowing use of additional features of the BlackBerry Location Manager. They correspond to the fields of the dat parameter of the location request. Set these properties prior to calling startUpdates() or requestUpdate().

period

This property specifies the period of the satellite update request, in seconds. A value of '0' indicates a one-time update request.

source->setProperty( "period", 5.0 );

responseTime

This property specifies the desired response time of the update, in seconds. A value of '0' disables response time criteria.

source->setProperty( "responseTime", 10.0 );

canRunInBackground

This property determines whether or not requests are allowed to run with the device in standby (i.e. screen off)

source->setProperty( "canRunInBackground", true );

Public Functions Index

QGeoSatelliteInfoSource (QObject *parent)

Static Public Functions Index

QGeoSatelliteInfoSource *	createDefaultSource (QObject *parent)
QGeoSatelliteInfoSource *	createSource (const QString &sourceName, QObject *parent)
QStringList	availableSources ()

Public Slots Index

void	startUpdates ()=0
void	stopUpdates ()=0
void	requestUpdate (int timeout=0)=0

Signals Index

void	satellitesInViewUpdated (const QList< QGeoSatelliteInfo > &satellites)
void	satellitesInUseUpdated (const QList< QGeoSatelliteInfo > &satellites)
void	requestTimeout ()

Public Functions

QGeoSatelliteInfoSource (
QObject *parent)

Creates a source with the specified parent.

Static Public Functions

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.

Returns 0 if the system has no default source and no valid plugins could be found.

QGeoSatelliteInfoSource * createSource (
const QString &sourceName,
QObject *parent )

Creates and returns a source with the given parent, by loading the plugin named sourceName.

Returns 0 if the plugin cannot be found.

QStringList availableSources ()

Returns a list of available source plugins.

Note that this does not include the default system backend, if one is available.

Public Slots

void startUpdates ()

Starts emitting updates at regular intervals.

The updates will be provided whenever new satellite information becomes available.

See:

satellitesInViewUpdated(), satellitesInUseUpdated()

void stopUpdates ()

Stops emitting updates at regular intervals.

void requestUpdate (
inttimeout)

Attempts to get the current satellite information and emit satellitesInViewUpdated() and satellitesInUseUpdated() with this information.

If the current position cannot be found within the given timeout (in milliseconds), requestTimeout() is emitted.

If the timeout is zero, the timeout defaults to a reasonable timeout period as appropriate for the source.

This does nothing if another update request is in progress. However it can be called even if startUpdates() has already been called and regular updates are in progress.

Signals

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.

The satellites parameter holds the satellites 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.

These are the satellites that are used to get a "fix" - that is, those used to determine the current position.

The satellites parameter holds the satellites currently in use.

void requestTimeout ()

Emitted if requestUpdate() was called and the current satellite information could not be retrieved within the specified timeout.

© 2008-2011 Nokia Corporation and/or its subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation in Finland and/or other countries worldwide. All other trademarks are property of their respective owners. Privacy Policy

Licensees holding valid Qt Commercial licenses may use this document in accordance with the Qt Commercial License Agreement provided with the Software or, alternatively, in accordance with the terms contained in a written agreement between you and Nokia. Alternatively, this document may be used under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation.