FlpLocationInterface-Strukturreferenz

Datenfelder
FlpLocationInterface-Strukturreferenz

#include < fused_location.h >

Datenfelder

size_t Größe
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)
Leere(* Aufräumen )()
Leere(* get_batched_location )(int last_n_locations)
int(* inject_location )( FlpLocation *location)
const void *(* get_extension )(const char *name)
Leere(* Flush_batched_locations )()

detaillierte Beschreibung

Stellt die Standard-FLP-Schnittstelle dar.

Definition in Zeile 321 der Datei Fused_location.h .

Felddokumentation

void(* Aufräumen)()

Schließt die Schnittstelle. Wenn Batch-Vorgänge ausgeführt werden, sollten diese gestoppt werden.

Definition in Zeile 398 der Datei Fused_location.h .

void(* flush_batched_locations)()

Rufen Sie alle derzeit gespeicherten Stapelspeicherorte ab und löschen Sie den Puffer. flp_location_callback MUSS als Antwort aufgerufen werden, auch wenn keine Speicherorte zum Leeren vorhanden sind (in diesem Fall sollte num_locations 0 sein). Nachfolgende Aufrufe von „get_batched_location“ oder „flush_batched_locations“ sollten keinen der in diesem Aufruf zurückgegebenen Speicherorte zurückgeben.

Definition in Zeile 436 der Datei Fused_location.h .

int(* get_batch_size)()

Gibt die in der Hardware verfügbare Batchgröße (in Anzahl der FlpLocation- Objekte) zurück. Beachten Sie, dass unterschiedliche HW-Implementierungen unterschiedliche Stichprobengrößen haben können. Dies soll die Anzahl der im FlpLocation- Format definierten Samples zurückgeben. Dies wird von der oberen Schicht verwendet, um über das Batch-Intervall zu entscheiden und ob der AP aktiviert werden soll oder nicht.

Definition in Zeile 343 der Datei Fused_location.h .

void(* get_batched_location)(int last_n_locations)

Rufen Sie den zusammengeführten Standort ab, der gestapelt wurde. flp_location_callback wird verwendet, um den Standort zurückzugeben. Das Standortobjekt wird nur dann aus dem Puffer gelöscht, wenn der Puffer voll ist. Entfernen Sie es nicht aus dem Puffer, nur weil es mithilfe des Rückrufs zurückgegeben wurde. Mit anderen Worten: Wenn kein neues Standortobjekt vorhanden ist, sollten zwei Aufrufe von get_batched_location(1) dasselbe Standortobjekt zurückgeben. Parameter: last_n_locations – Anzahl der abzurufenden Standorte. Dies kann einer oder mehrere sein. Wenn last_n_locations 1 ist, erhalten Sie den letzten der Hardware bekannten Standort.

Definition in Zeile 412 der Datei Fused_location.h .

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

Rufen Sie einen Zeiger auf Erweiterungsinformationen ab.

Definition in Zeile 427 der Datei Fused_location.h .

int(* init)( FlpCallbacks *callbacks)

Öffnet die Schnittstelle und stellt die Rückrufroutinen für die Implementierung dieser Schnittstelle bereit. Nach dem Aufruf sollten Sie mit dem Aufruf von flp_capabilities_callback in FlpCallbacks reagieren, um die von Ihrer Implementierung unterstützten Funktionen anzugeben.

Definition in Zeile 333 der Datei Fused_location.h .

int(* inject_location)( FlpLocation *location)

Fügt den aktuellen Standort von einem anderen Standortanbieter ein. Breiten- und Längengrad werden in Grad gemessen. Die erwartete Genauigkeit wird in Metern gemessen. Parameter: Standort – Das Standortobjekt, das eingefügt wird. 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) setzen

Definition in Zeile 325 der Datei Fused_location.h .

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

Starten Sie die Batch-Standorte. Diese API wird hauptsächlich verwendet, wenn der AP schläft und das Gerät Standorte in der Hardware stapeln kann. flp_location_callback wird verwendet, um die Standorte zurückzugeben. Wenn der Puffer voll ist und FLP_BATCH_WAKEUP_ON_FIFO_FULL verwendet wird, wird der AP aufgeweckt. 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 AP nicht aufgeweckt. Die obere Ebene verwendet die API get_batched_location, um explizit nach dem Standort zu fragen. Wenn FLP_BATCH_CALLBACK_ON_LOCATION_FIX festgelegt ist, ruft die Implementierung jedes Mal, wenn eine Standortkorrektur vorliegt, flp_location_callback auf. Dies überschreibt die Flag-Einstellung FLP_BATCH_WAKEUP_ON_FIFO_FULL. Es liegt in der Verantwortung der oberen Schichten (Anrufer), es auszuschalten, wenn sie wissen, dass der AP möglicherweise in den Ruhezustand wechselt. Dies ist für Navigationsanwendungen nützlich, wenn sich das System im Hochleistungsmodus befindet. Parameter: id – ID für die Anfrage. Optionen – Siehe FlpBatchOptions -Strukturdefinition. Rückgabewert: FLP_RESULT_SUCCESS bei Erfolg, FLP_RESULT_INSUFFICIENT_MEMORY, FLP_RESULT_ID_EXISTS, FLP_RESULT_ERROR bei Fehler.

Definition in Zeile 367 der Datei Fused_location.h .

int(* stop_batching)(int id)

Hören Sie auf zu stapeln. 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 FlpBatchOptions, die einer Batchverarbeitungsanforderung zugeordnet sind. Wenn ein Batch-Vorgang ausgeführt wird und eine Batch-Option wie FLP_BATCH_WAKEUP_ON_FIFO_FULL aktualisiert werden muss, wird diese API verwendet. Dies kann beispielsweise passieren, wenn der AP aktiv ist und die Kartenanwendung verwendet wird. Parameter: id – ID einer vorhandenen Batch-Anfrage. new_options – Aktualisierter FlpBatchOptions -Rückgabewert: FLP_RESULT_SUCCESS bei Erfolg, FLP_RESULT_ID_UNKNOWN, 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: