FlpLocationInterface-Strukturreferenz

Datenfelder
FlpLocationInterface-Strukturreferenz

#include < fused_location.h >

Datenfelder

size_t  size
 
int(*  init )( FlpCallbacks *callbacks)
 
int(*  get_batch_size )()
 
int(*  start_batching )(int id, FlpBatchOptions *options)
 
int(*  update_batching_options )(int id, FlpBatchOptions *new_options)
 
int(*  stop_batching )(int id)
 
void(*  cleanup )()
 
void(*  get_batched_location )(int last_n_locations)
 
int(*  inject_location )( FlpLocation *location)
 
const void *(*  get_extension )(const char *name)
 
void(*  flush_batched_locations )()
 

Detaillierte Beschreibung

Stellt die Standard-FLP-Schnittstelle dar.

Definition in Zeile 321 der Datei fused_location.h .

Felddokumentation

void(* cleanup)()

Schließt die Benutzeroberfläche. Laufende Batchvorgänge sollten beendet werden.

Definition in Zeile 398 der Datei fused_location.h .

void(* flush_batched_locations)()

Rufen Sie alle derzeit gespeicherten Standorte ab und leeren Sie den Puffer. flp_location_callback MUSS als Antwort aufgerufen werden, auch wenn keine Standorte gelöscht werden müssen (in diesem Fall sollte „num_locations“ = 0 sein). Bei nachfolgenden Aufrufen von „get_batched_location“ oder „flush_batched_locations“ sollten keine der in diesem Aufruf zurückgegebenen Standorte zurückgegeben werden.

Definition in Zeile 436 der Datei fused_location.h .

int(* get_batch_size)()

Gibt die Batchgröße (in der Anzahl der FlpLocation -Objekte) zurück, die auf der Hardware verfügbar ist. Hinweis: Unterschiedliche Hardwareimplementierungen können unterschiedliche Stichprobengrößen haben. Dies gibt die Anzahl der Samples zurück, die im Format FlpLocation definiert sind. Dieser Wert wird von der übergeordneten Schicht verwendet, um das Batch-Intervall zu bestimmen und festzulegen, ob der ZP geweckt werden soll oder nicht.

Definition in Zeile 343 der Datei fused_location.h .

void(* get_batched_location)(int last_n_locations)

Rufen Sie den kombinierten Standort ab, der im Batch verarbeitet wurde. Der Standort wird über flp_location_callback zurückgegeben. Das Standortobjekt wird nur dann aus dem Puffer entfernt, wenn der Puffer voll ist. Entferne es nicht aus dem Puffer, nur weil es über den Rückruf zurückgegeben wurde. Wenn also kein neues Standortobjekt vorhanden ist, sollten zwei Aufrufe von „get_batched_location(1)“ dasselbe Standortobjekt zurückgeben. Parameter: last_n_locations – Anzahl der Standorte, die abgerufen werden sollen. Es kann sich um eine oder mehrere Personen handeln. Wenn „last_n_locations“ den Wert „1“ hat, wird der der Hardware zuletzt bekannte Standort zurückgegeben.

Definition in Zeile 412 der Datei fused_location.h .

const void*(* get_extension)(const char *name)

Einen Verweis auf Erweiterungsinformationen erhalten

Definition in Zeile 427 der Datei fused_location.h .

int(* init)( FlpCallbacks *callbacks)

Öffnet die Benutzeroberfläche und stellt die Callback-Routinen für die Implementierung dieser Benutzeroberfläche bereit. Wenn du aufgerufen wirst, solltest du den flp_capabilities_callback in FlpCallbacks aufrufen, um die von deiner Implementierung unterstützten Funktionen anzugeben.

Definition in Zeile 333 der Datei fused_location.h .

int(* inject_location)( FlpLocation *location)

Fügt den aktuellen Standort eines anderen Standortanbieters ein. Breiten- und Längengrad werden in Grad gemessen, die erwartete Genauigkeit in Metern. Parameter: „location“ – das einzufügende Standortobjekt. Rückgabewert: FLP_RESULT_SUCCESS oder FLP_RESULT_ERROR.

Definition in Zeile 422 der Datei fused_location.h .

size_t-Größe

auf sizeof(FlpLocationInterface) festgelegt

Definition in Zeile 325 der Datei fused_location.h .

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

Standorte in Batches hinzufügen Diese API wird hauptsächlich verwendet, wenn der ZP im Ruhemodus ist und das Gerät Standorte in der Hardware gruppieren kann. Die Standorte werden über flp_location_callback zurückgegeben. Wenn der Puffer voll ist und FLP_BATCH_WAKEUP_ON_FIFO_FULL verwendet wird, wird der AP geweckt. Wenn der Puffer voll ist und FLP_BATCH_WAKEUP_ON_FIFO_FULL nicht festgelegt ist, wird das älteste Standortobjekt gelöscht. In diesem Fall wird der ZP nicht geweckt. Die oberste Schicht verwendet die get_batched_location API, um den Standort explizit anzufordern. Wenn FLP_BATCH_CALLBACK_ON_LOCATION_FIX festgelegt ist, ruft die Implementierung die Funktion „flp_location_callback“ jedes Mal auf, wenn eine Standortbestimmung erfolgt. Dadurch wird die Flag-Einstellung FLP_BATCH_WAKEUP_ON_FIFO_FULL überschrieben. Es liegt in der Verantwortung der höheren Schichten (Caller), ihn auszuschalten, wenn sie wissen, dass der ZP in den Ruhemodus wechseln könnte. Das ist nützlich für Navigationsanwendungen, wenn sich das System im Hochleistungsmodus befindet. Parameter: id – ID für die Anfrage. options – siehe Strukturdefinition FlpBatchOptions . Rückgabewert: FLP_RESULT_SUCCESS bei Erfolg, FLP_RESULT_INSUFFICIENT_MEMORY, FLP_RESULT_ID_EXISTS oder FLP_RESULT_ERROR bei Fehler.

Definition in Zeile 367 der Datei fused_location.h .

int(* stop_batching)(int id)

Beenden Sie die Batch-Dateien. Parameter: id – ID für die Anfrage. Rückgabewert: FLP_RESULT_SUCCESS bei Erfolg, FLP_RESULT_ID_UNKNOWN oder FLP_RESULT_ERROR bei Fehler.

Definition in Zeile 392 der Datei fused_location.h .

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

Aktualisieren Sie die FlpBatchOptions , die mit einer Batchanfrage verknüpft sind. Wenn ein Batchvorgang ausgeführt wird und eine Batchoption wie FLP_BATCH_WAKEUP_ON_FIFO_FULL aktualisiert werden muss, wird diese API verwendet. Dies kann beispielsweise der Fall sein, wenn der ZP aktiv ist und die Kartenanwendung verwendet wird. Parameter: id – ID einer vorhandenen Batchanfrage. new_options – aktualisierte FlpBatchOptions Rückgabewert: FLP_RESULT_SUCCESS bei Erfolg, FLP_RESULT_ID_UNKNOWN oder FLP_RESULT_ERROR bei Fehler.

Definition in Zeile 382 der Datei fused_location.h .

Die Dokumentation für diese Struktur wurde aus der folgenden Datei generiert: