ArcGIS for Developers

SatelliteInfoSource QML Type

Provides information about satellites currently in use. More...

Import Statement: import ArcGIS.AppFramework.Positioning 1.0

Properties

Signals

Methods

Detailed Description

This code sample displays the usage of SatelliteInfoSource.

SatelliteInfoSource {
    id: satelliteSource

    active: true

    nmeaSource: NmeaSource {source: currentDevice}
}

Enumerations

SourceError enumeration

This enum describes the types of errors faced by the class. Informs the sourceError property.

NameValue
SatelliteInfoSource.UnknownSourceError-1
SatelliteInfoSource.AccessError0
SatelliteInfoSource.ClosedError1
SatelliteInfoSource.NoError2
SatelliteInfoSource.SocketError100

TalkerType enumeration

NameValue
SatelliteInfoSource.Unknown0
SatelliteInfoSource.Glonass1
SatelliteInfoSource.Gps2
SatelliteInfoSource.Mixed3
SatelliteInfoSource.LoranC4
SatelliteInfoSource.IntegratedInstrumentation8
SatelliteInfoSource.IntegratedNavigation16
SatelliteInfoSource.Ecdis32
SatelliteInfoSource.Dsc64
SatelliteInfoSource.Galileo128
SatelliteInfoSource.Beidou256
SatelliteInfoSource.Qzss512

Property Documentation

active : bool

Returns true if updates are being provided. Otherwise, returns false.


name : string

Returns the unique name of the satellite source implementation in use.


nmeaSource : object

An NmeaSource object that provides satellite updates through NMEA sentences. Cannot be stored as a URL.


[read-only] satellitesInUse : SatelliteListModel

Returns a SatelliteListModel of satellites that are being used to get a position fix.


[read-only] satellitesInView : SatelliteListModel

Returns a SatelliteListModel of satellites in view.


[read-only] sourceError : SourceError

Returns the last error encountered by the class. Informed by the SourceError property.


updateInterval : int

The update interval for the class in milliseconds. Default is 0, which will provide an update when available from the source.


[read-only] valid : bool

Returns true if the class has a valid nmeaSource.


Signal Documentation

requestUpdateTimeout()

Signal emitted when the requestUpdate method times out.


Method Documentation

requestUpdate()

Requests an update to all properties for the class.


start()

Starts emitting updates at regular intervals. These updates will be provided after the amount of milliseconds provided by the updateInterval property, or whenever new satellite information is available if updateInterval is 0.


stop()

Stops emitting updates at reguler intervals.