MeeGo 1.2 Harmattan Developer Documentation Develop for the Nokia N9

Contents

QGeoSatelliteInfoSource Class Reference

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

 #include <QGeoSatelliteInfoSource>

Inherits: QObject.

This class was introduced in Qt Mobility 1.0.

Public Functions

QGeoSatelliteInfoSource ( QObject * parent )
  • 29 public functions inherited from QObject

Public Slots

virtual void requestUpdate ( int timeout = 0 ) = 0
virtual void startUpdates () = 0
virtual void stopUpdates () = 0
  • 1 public slot inherited from QObject

Signals

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

Static Public Members

QStringList availableSources ()
QGeoSatelliteInfoSource * createDefaultSource ( QObject * parent )
QGeoSatelliteInfoSource * createSource ( const QString & sourceName, QObject * parent )
  • 4 static public members inherited from QObject

Additional Inherited Members

  • 1 property inherited from QObject
  • 1 public variable inherited from QObject
  • 7 protected functions inherited from QObject
  • 2 protected variables inherited from QObject

Detailed Description

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

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.

Warning: On Windows CE it is not possible to detect if a device is GPS enabled. The default satellite source on a Windows CE device without GPS support will never provide any satellite data.

Warning: On Symbian it is currently only possible to instantiate and use the satellite sources in the main thread of the application.

Member Function Documentation

QGeoSatelliteInfoSource::QGeoSatelliteInfoSource ( QObject * parent )

Creates a source with the specified parent.

QStringList QGeoSatelliteInfoSource::availableSources () [static]

Returns a list of available source plugins. Note that this does not include the default system backend, if one is available.

QGeoSatelliteInfoSource * QGeoSatelliteInfoSource::createDefaultSource ( QObject * parent ) [static]

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.

Note: Symbian applications will need to have the Location capability otherwise this will return 0.

This function was introduced in Qt Mobility 1.0.

QGeoSatelliteInfoSource * QGeoSatelliteInfoSource::createSource ( const QString & sourceName, QObject * parent ) [static]

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

Returns 0 if the plugin cannot be found.

void QGeoSatelliteInfoSource::requestTimeout () [signal]

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

This function was introduced in Qt Mobility 1.0.

void QGeoSatelliteInfoSource::requestUpdate ( int timeout = 0 ) [pure virtual slot]

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.

This function was introduced in Qt Mobility 1.0.

void QGeoSatelliteInfoSource::satellitesInUseUpdated ( const QList<QGeoSatelliteInfo> & satellites ) [signal]

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.

This function was introduced in Qt Mobility 1.0.

void QGeoSatelliteInfoSource::satellitesInViewUpdated ( const QList<QGeoSatelliteInfo> & satellites ) [signal]

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.

This function was introduced in Qt Mobility 1.0.

void QGeoSatelliteInfoSource::startUpdates () [pure virtual slot]

Starts emitting updates at regular intervals. The updates will be provided whenever new satellite information becomes available.

This function was introduced in Qt Mobility 1.0.

See also satellitesInViewUpdated() and satellitesInUseUpdated().

void QGeoSatelliteInfoSource::stopUpdates () [pure virtual slot]

Stops emitting updates at regular intervals.

This function was introduced in Qt Mobility 1.0.

© 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.