Riferimento alla struttura FlpLocationInterface

Campi dati
Riferimento alla struttura FlpLocationInterface

#include < fused_location.h >

Campi dati

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 )()
 

Descrizione dettagliata

Rappresenta l'interfaccia FLP standard.

Definizione nella riga 321 del file fused_location.h .

Documentazione dei campi

void(* cleanup)()

Chiude l'interfaccia. Se sono in corso operazioni collettive, devono essere interrotte.

Definizione alla riga 398 del file fused_location.h .

void(* flush_batched_locations)()

Recupera tutte le posizioni raggruppate attualmente memorizzate e svuota il buffer. In risposta, deve essere chiamato flp_location_callback, anche se non ci sono posizioni da svuotare (in questo caso num_locations deve essere 0). Le chiamate successive a get_batched_location o flush_batched_locations non devono restituire nessuna delle posizioni restituite in questa chiamata.

Definizione nella riga 436 del file fused_location.h .

int(* get_batch_size)()

Restituisce la dimensione del batch (in numero di oggetti FlpLocation disponibili nell'hardware. Tieni presente che implementazioni HW diverse potrebbero avere dimensioni del campione diverse. Deve restituire il numero di campioni definiti nel formato di FlpLocation . Verrà utilizzato dal livello superiore per decidere sull'intervallo di raggruppamento e se riattivare o meno l'AP.

Definizione nella riga 343 del file fused_location.h .

void(* get_batched_location)(int last_n_locations)

Recupera la posizione combinata raggruppata. flp_location_callback viene utilizzato per restituire la posizione. L'oggetto posizione viene eliminato dal buffer solo quando è pieno. Non rimuoverlo dal buffer solo perché è stato restituito utilizzando il callback. In altre parole, quando non è presente un nuovo oggetto Location, due chiamate a get_batched_location(1) devono restituire lo stesso oggetto Location. Parametri: last_n_locations - Numero di località da recuperare. Possono essere uno o più. Se last_n_locations è 1, viene visualizzata l'ultima posizione nota all'hardware.

Definizione nella riga 412 del file fused_location.h .

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

Ottieni un puntatore alle informazioni sull'estensione.

Definizione nella riga 427 del file fused_location.h .

int(* init)( FlpCallbacks *callbacks)

Apre l'interfaccia e fornisce le routine di callback per l'implementazione di questa interfaccia. Una volta chiamato, devi rispondere chiamando flp_capabilities_callback in FlpCallbacks per specificare le funzionalità supportate dalla tua implementazione.

Definizione nella riga 333 del file fused_location.h .

int(* inject_location)( FlpLocation *location)

Inserisce la posizione corrente di un altro fornitore di dati sulla posizione. La latitudine e la longitudine vengono misurate in gradi e la precisione prevista viene misurata in metri. Parametri: location: l'oggetto location da iniettare. Valore restituito: FLP_RESULT_SUCCESS o FLP_RESULT_ERROR.

Definizione nella riga 422 del file fused_location.h .

Dimensione size_t

impostato su sizeof(FlpLocationInterface)

Definizione nella riga 325 del file fused_location.h .

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

Inizia a raggruppare le sedi. Questa API viene utilizzata principalmente quando l'AP è in modalità di sospensione e il dispositivo può raggruppare le posizioni nell'hardware. flp_location_callback viene utilizzato per restituire le posizioni. Quando il buffer è pieno e viene utilizzato FLP_BATCH_WAKEUP_ON_FIFO_FULL, l'AP viene riattivato. Quando il buffer è pieno e FLP_BATCH_WAKEUP_ON_FIFO_FULL non è impostato, l'oggetto Location più vecchio viene eliminato. In questo caso, l'AP non verrà riattivato. Il livello superiore utilizzerà l'API get_batched_location per richiedere esplicitamente la posizione. Se FLP_BATCH_CALLBACK_ON_LOCATION_FIX è impostato, l'implementazione chiamerà flp_location_callback ogni volta che viene rilevata una correzione della posizione. Questa impostazione sostituisce l'impostazione del flag FLP_BATCH_WAKEUP_ON_FIFO_FULL. È responsabilità dei livelli superiori (chiama) disattivarlo, se sanno che l'AP potrebbe andare in sospensione. Questo è utile per le applicazioni di navigazione quando il sistema è in modalità di alta potenza. Parametri: id: l'ID della richiesta. options: consulta la definizione dello struct FlpBatchOptions . Valore restituito: FLP_RESULT_SUCCESS in caso di esito positivo, FLP_RESULT_INSUFFICIENT_MEMORY, FLP_RESULT_ID_EXISTS, FLP_RESULT_ERROR in caso di errore.

Definizione alla riga 367 del file fused_location.h .

int(* stop_batching)(int id)

Interrompi l'elaborazione collettiva. Parametri: id: l'ID della richiesta. Valore restituito: FLP_RESULT_SUCCESS in caso di esito positivo, FLP_RESULT_ID_UNKNOWN o FLP_RESULT_ERROR in caso di errore.

Definizione alla riga 392 del file fused_location.h .

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

Aggiorna FlpBatchOptions associato a una richiesta di raggruppamento. Quando è in corso un'operazione di raggruppamento e un'opzione di raggruppamento come FLP_BATCH_WAKEUP_ON_FIFO_FULL deve essere aggiornata, viene utilizzata questa API. Ad esempio, questo può accadere quando l'AP è attivo e viene utilizzata l'applicazione Maps. Parametri: id: ID di una richiesta batch esistente. new_options: FlpBatchOptions aggiornato Valore restituito: FLP_RESULT_SUCCESS in caso di esito positivo, FLP_RESULT_ID_UNKNOWN, FLP_RESULT_ERROR in caso di errore.

Definizione nella riga 382 del file fused_location.h .

La documentazione di questa struttura è stata generata dal seguente file: