SatelliteSource QML Type

La classe SatelliteSource fournit des informations sur les satellites. Plus d'informations...

• Liste de tous les membres, y compris les membres hérités

Propriétés

• active : bool
• name : string
• parameters : list<PluginParameter>
• satellitesInUse : list<geoSatelliteInfo>
• satellitesInView : list<geoSatelliteInfo>
• sourceError : enumeration
• updateInterval : int
• valid : bool

Méthodes

• var backendProperty(string name)
• bool setBackendProperty(string name, var value)
• void start()
• void stop()
• void update(int timeout)

Description détaillée

La classe SatelliteSource fournit des informations sur les satellites utilisés et les satellites en vue. Cette classe est une représentation QML de QGeoSatelliteInfoSource.

Comme son équivalent en C++, la classe prend en charge différents plugins. Utilisez la propriété name pour spécifier le nom du plugin à utiliser et fournissez PluginParameters, si nécessaire. Si la propriété name n'est pas définie, un plugin par défaut sera utilisé. Voir Qt Positioning Plugins pour plus d'informations sur les plugins disponibles.

Utilisez la propriété valid pour vérifier l'état de SatelliteSource.

Utilisez la propriété updateInterval pour indiquer la fréquence à laquelle votre application souhaite recevoir les mises à jour des informations satellite. Les méthodes start(), stop() et update() peuvent être utilisées pour contrôler le fonctionnement de la source satellite, ainsi que la propriété active qui, lorsqu'elle est définie, équivaut à appeler start() ou stop().

Lorsque la source satellite est active, les mises à jour des informations satellite peuvent être récupérées à l'aide des propriétés satellitesInView et satellitesInUse.

Si une erreur se produit lors de la mise à jour des informations satellite, utilisez la propriété sourceError pour obtenir le code d'erreur actuel.

Exemple d'utilisation

L'exemple suivant montre une SatelliteSource qui utilise le plugin NMEA pour recevoir des mises à jour d'informations satellite toutes les secondes et imprimer la quantité de satellites en vue et de satellites en cours d'utilisation sur la console.

SatelliteSource {
    id: source
    name: "nmea"
    active: true
    updateInterval: 1000
    PluginParameter { name: "nmea.source"; value: "serial:/dev/ttyACM0" }

    onSatellitesInUseChanged: {
        console.log("Satellites in use:", source.satellitesInUse.length)
    }
    onSatellitesInViewChanged: {
        console.log("Satellites in view:", source.satellitesInView.length)
    }
}

Voir également QGeoSatelliteInfoSource, PluginParameter, et geoSatelliteInfo.

Documentation sur les propriétés

active : bool

Cette propriété indique si la source satellite est active. La définition de cette propriété à false équivaut à appeler stop, et la définition de cette propriété à true équivaut à appeler start.

Voir également start, stop, et update.

name : string

Cette propriété contient le nom interne unique du plugin qui fournit actuellement les informations sur les satellites.

En définissant cette propriété, le site SatelliteSource utilise un plugin particulier. Si le site SatelliteSource est actif au moment où la propriété name est modifiée, il devient inactif. Si le backend spécifié ne peut pas être chargé, la source satellite devient invalide.

La modification de la propriété name peut entraîner la modification de la propriété updateInterval.

parameters : list<PluginParameter> [default read-only]

Cette propriété contient la liste des paramètres du plugin.

Voir aussi PluginParameter.

satellitesInUse : list<geoSatelliteInfo> [read-only]

Cette propriété contient la liste des satellites actuellement utilisés. Il s'agit des satellites utilisés pour obtenir un "point", c'est-à-dire ceux utilisés pour déterminer la position actuelle.

satellitesInView : list<geoSatelliteInfo> [read-only]

Cette propriété contient la liste des satellites actuellement en vue.

sourceError : enumeration [read-only]

Cette propriété contient la dernière erreur qui s'est produite avec le fournisseur de données dorsal.

updateInterval : int

Cette propriété indique l'intervalle souhaité entre les mises à jour en millisecondes.

valid : bool [read-only]

Cette propriété vaut true si l'objet SatelliteSource a acquis un plugin backend valide pour fournir des données, et false dans le cas contraire.

Les applications doivent vérifier cette propriété pour déterminer si la fourniture d'informations sur les satellites est disponible et activée sur la plate-forme d'exécution, et réagir en conséquence.

Documentation de la méthode

var backendProperty(string name)

Renvoie la valeur de la propriété spécifique au backend nommée name, si elle est présente. Sinon, y compris si elle est appelée sur un SatelliteSource non initialisé, la valeur de retour sera invalide.

Voir aussi setBackendProperty().

bool setBackendProperty(string name, var value)

Définit la propriété spécifique au backend nommée name en value. Retourne true en cas de succès, false dans le cas contraire, y compris s'il est appelé sur un SatelliteSource non initialisé.

Voir aussi backendProperty().

void start()

Demande des mises à jour à la source satellite. Utilise updateInterval s'il est défini, l'intervalle par défaut dans le cas contraire. Si aucune source n'est disponible, cette méthode n'a aucun effet.

Voir également stop(), update() et active.

void stop()

Arrête les mises à jour de la source satellite. Si aucune source n'est disponible ou si elle n'est pas active, cette méthode n'a aucun effet.

Voir également start(), update() et active.

void update(int timeout = 0)

Une méthode de commodité pour demander une seule mise à jour à la source du satellite. Si aucune source n'est disponible, cette méthode n'a aucun effet.

Si la source satellite n'est pas active, elle sera activée le temps de recevoir une mise à jour ou jusqu'à ce que la demande soit épuisée. Le délai d'attente de la demande est spécifique à chaque plugin.

L'adresse timeout est spécifiée en millisecondes. Si timeout est égal à zéro (valeur par défaut), le délai d'attente est fixé par défaut à un niveau raisonnable, en fonction de la source.

Voir également start(), stop() et active.