QGeoSatelliteInfoSource Class Reference

 #include <QGeoSatelliteInfoSource>

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.