Référence de structure FlpLocationInterface

Champs de données
Référence de structure FlpLocationInterface

#include < fused_location.h >

Champs de données

taille_t taille
entier(* init )( FlpCallbacks *rappels)
entier(* get_batch_size )()
entier(* start_batching )(identifiant int, FlpBatchOptions *options)
entier(* update_batching_options )(identifiant int, FlpBatchOptions *new_options)
entier(* stop_batching )(identifiant int)
vide(* nettoyer )()
vide(* get_batched_location )(int last_n_locations)
entier(* inject_location )( FlpLocation *emplacement)
const vide *(* get_extension )(const char *nom)
vide(* flush_batched_locations )()

Description détaillée

Représente l'interface FLP standard.

Définition à la ligne 321 du fichier fused_location.h .

Documentation de terrain

void(* nettoyage)()

Ferme l'interface. Si des opérations par lots sont en cours, elles doivent être arrêtées.

Définition à la ligne 398 du fichier fused_location.h .

void(* flush_batched_locations)()

Récupérez tous les emplacements par lots actuellement stockés et effacez le tampon. flp_location_callback DOIT être appelé en réponse, même s'il n'y a aucun emplacement à vider (auquel cas num_locations doit être 0). Les appels ultérieurs à get_batched_location ou flush_batched_locations ne doivent renvoyer aucun des emplacements renvoyés dans cet appel.

Définition à la ligne 436 du fichier fused_location.h .

int(* get_batch_size)()

Renvoie la taille du lot (en nombre d'objets FlpLocation ) disponible dans le matériel. Notez que différentes implémentations matérielles peuvent avoir des tailles d'échantillon différentes. Cela doit renvoyer le nombre d’échantillons définis au format FlpLocation . Ceci sera utilisé par la couche supérieure pour décider de l'intervalle de traitement par lots et si l'AP doit être réveillé ou non.

Définition à la ligne 343 du fichier fused_location.h .

void(* get_batched_location)(int last_n_locations)

Obtenez l'emplacement fusionné qui a été regroupé. flp_location_callback est utilisé pour renvoyer l'emplacement. L'objet d'emplacement est supprimé du tampon uniquement lorsque le tampon est plein. Ne le supprimez pas du tampon simplement parce qu'il a été renvoyé à l'aide du rappel. En d'autres termes, lorsqu'il n'y a pas de nouvel objet de localisation, deux appels à get_batched_location(1) devraient renvoyer le même objet de localisation. Paramètres : last_n_locations - Nombre d'emplacements à obtenir. Cela peut être un ou plusieurs. Si last_n_locations vaut 1, vous obtenez le dernier emplacement connu du matériel.

Définition à la ligne 412 du fichier fused_location.h .

const void*(* get_extension)(const char *nom)

Obtenez un pointeur vers les informations d’extension.

Définition à la ligne 427 du fichier fused_location.h .

int(* init)( FlpCallbacks *rappels)

Ouvre l'interface et fournit les routines de rappel pour l'implémentation de cette interface. Une fois appelé, vous devez répondre en appelant flp_capabilities_callback dans FlpCallbacks pour spécifier les fonctionnalités prises en charge par votre implémentation.

Définition à la ligne 333 du fichier fused_location.h .

int(* inject_location)( FlpLocation *emplacement)

Injecte l'emplacement actuel d'un autre fournisseur de localisation. La latitude et la longitude sont mesurées en degrés. La précision attendue est mesurée en mètres. Paramètres : emplacement - L'objet de localisation en cours d'injection. Valeur de retour : FLP_RESULT_SUCCESS ou FLP_RESULT_ERROR.

Définition à la ligne 422 du fichier fused_location.h .

taille_t taille

défini sur sizeof (FlpLocationInterface)

Définition à la ligne 325 du fichier fused_location.h .

int(* start_batching)(identifiant int, FlpBatchOptions *options)

Commencez à regrouper les emplacements. Cette API est principalement utilisée lorsque le point d'accès est en veille et que l'appareil peut regrouper des emplacements dans le matériel. flp_location_callback est utilisé pour renvoyer les emplacements. Lorsque le tampon est plein et que FLP_BATCH_WAKEUP_ON_FIFO_FULL est utilisé, l'AP est réveillé. Lorsque le tampon est plein et que FLP_BATCH_WAKEUP_ON_FIFO_FULL n'est pas défini, l'objet d'emplacement le plus ancien est supprimé. Dans ce cas, l'AP ne sera pas réveillé. La couche supérieure utilisera l'API get_batched_location pour demander explicitement l'emplacement. Si FLP_BATCH_CALLBACK_ON_LOCATION_FIX est défini, l'implémentation appellera flp_location_callback à chaque fois qu'il y aura un correctif d'emplacement. Cela remplace le paramètre d'indicateur FLP_BATCH_WAKEUP_ON_FIFO_FULL. Il est de la responsabilité des couches supérieures (appelant) de l'éteindre, si elles savent que l'AP pourrait se mettre en veille. Ceci est utile pour les applications de navigation lorsque le système est en mode haute puissance. Paramètres : id - Identifiant de la requête. options - Voir la définition de la structure FlpBatchOptions . Valeur de retour : FLP_RESULT_SUCCESS en cas de succès, FLP_RESULT_INSUFFICIENT_MEMORY, FLP_RESULT_ID_EXISTS, FLP_RESULT_ERROR en cas d'échec.

Définition à la ligne 367 du fichier fused_location.h .

int(* stop_batching)(identifiant int)

Arrêtez de faire des lots. Paramètres : id - Identifiant de la requête. Valeur de retour : FLP_RESULT_SUCCESS en cas de succès, FLP_RESULT_ID_UNKNOWN ou FLP_RESULT_ERROR en cas d'échec.

Définition à la ligne 392 du fichier fused_location.h .

int(* update_batching_options)(identifiant int, FlpBatchOptions *new_options)

Mettez à jour les FlpBatchOptions associées à une demande de traitement par lots. Lorsqu'une opération de traitement par lots est en cours et qu'une option de traitement par lots telle que FLP_BATCH_WAKEUP_ON_FIFO_FULL doit être mise à jour, cette API sera utilisée. Par exemple, cela peut se produire lorsque le point d'accès est réveillé et que l'application de cartes est utilisée. Paramètres : id – Identifiant d'une demande par lots existante. new_options - FlpBatchOptions mis à jour Valeur de retour : FLP_RESULT_SUCCESS en cas de succès, FLP_RESULT_ID_UNKNOWN, FLP_RESULT_ERROR en cas d'erreur.

Définition à la ligne 382 du fichier fused_location.h .

La documentation de cette structure a été générée à partir du fichier suivant :