FlpLocationInterface Struct Reference

שדות נתונים
FlpLocationInterface Struct Reference

#include < fused_location.h >

שדות נתונים

size_t גודל
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)
בָּטֵל(* לנקות )()
בָּטֵל(* get_batched_location )(int last_n_locations)
int(* inject_location )( FlpLocation *location)
const void *(* get_extension )(const char *name)
בָּטֵל(* flush_batched_locations )()

תיאור מפורט

מייצג את ממשק FLP הסטנדרטי.

הגדרה בשורה 321 של הקובץ fused_location.h .

תיעוד שטח

void(* ניקוי)()

סוגר את הממשק. אם מתבצעות פעולות אצווה כלשהן, יש להפסיק אותן.

הגדרה בשורה 398 של הקובץ fused_location.h .

void(* flush_batched_locations)()

אחזר את כל המיקומים המאוחסנים כעת ונקה את המאגר. יש לקרוא ל-flp_location_callback בתגובה, גם אם אין מיקומים לניקוי (במקרה זה num_locations צריך להיות 0). קריאות עוקבות ל-get_batched_location או flush_batched_locations לא אמורות להחזיר אף אחד מהמיקומים שהוחזרו בקריאה זו.

הגדרה בשורה 436 של הקובץ fused_location.h .

int(* get_batch_size)()

החזר את גודל האצווה (במספר אובייקטי FlpLocation ) הזמין בחומרה. שים לב, למימושים שונים של HW עשויים להיות גדלי מדגם שונים. זה יחזיר מספר דגימות שהוגדרו בפורמט של FlpLocation . זה ישמש את השכבה העליונה, כדי להחליט על מרווח האצווה והאם יש להעיר את ה-AP או לא.

הגדרה בשורה 343 של הקובץ fused_location.h .

void(* get_batched_location)(int last_n_locations)

קבל את המיקום הממוזג שצורף. flp_location_callback משמש להחזרת המיקום. אובייקט המיקום נשמט מהמאגר רק כאשר המאגר מלא. אל תסיר אותו מהמאגר רק בגלל שהוא הוחזר באמצעות החזרה. במילים אחרות, כאשר אין אובייקט מיקום חדש, שתי קריאות ל-get_batched_location(1) צריכות להחזיר את אותו אובייקט מיקום. פרמטרים: last_n_locations - מספר המיקומים שיש להשיג. זה יכול להיות אחד או רבים. אם last_n_locations הוא 1, אתה מקבל את המיקום האחרון הידוע לחומרה.

הגדרה בשורה 412 של הקובץ fused_location.h .

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

קבל מצביע למידע על הרחבה.

הגדרה בשורה 427 של הקובץ fused_location.h .

int(* init)( FlpCallbacks *callbacks)

פותח את הממשק ומספק את שגרות ההתקשרות ליישום ממשק זה. לאחר התקשרות עליך להגיב על ידי קריאה ל-flp_capabilities_callback ב- FlpCallbacks כדי לציין את היכולות שבהן היישום שלך תומך.

הגדרה בשורה 333 של הקובץ fused_location.h .

int(* inject_location)( FlpLocation *location)

מזריק מיקום נוכחי מספק מיקום אחר קו הרוחב והאורך נמדדים במעלות דיוק צפוי נמדד במטרים פרמטרים: מיקום - אובייקט המיקום המוזרק. ערך החזרה: FLP_RESULT_SUCCESS או FLP_RESULT_ERROR.

הגדרה בשורה 422 של הקובץ fused_location.h .

size_t size

מוגדר ל-sizeof(FlpLocationInterface)

הגדרה בשורה 325 של הקובץ fused_location.h .

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

התחל לאסוף מיקומים. ממשק API זה משמש בעיקר כאשר ה-AP במצב רדום והמכשיר יכול לבצע אצווה של מיקומים בחומרה. flp_location_callback משמש להחזרת המיקומים. כאשר המאגר מלא ומשתמשים ב-FLP_BATCH_WAKEUP_ON_FIFO_FULL, ה-AP מתעורר. כאשר המאגר מלא ו-FLP_BATCH_WAKEUP_ON_FIFO_FULL אינו מוגדר, אובייקט המיקום הישן ביותר נשמט. במקרה זה ה-AP לא יועיר. השכבה העליונה תשתמש ב-get_batched_location API כדי לבקש במפורש את המיקום. אם FLP_BATCH_CALLBACK_ON_LOCATION_FIX מוגדר, היישום יתקשר ל-flp_location_callback בכל פעם שיש תיקון מיקום. זה עוקף את הגדרת הדגל FLP_BATCH_WAKEUP_ON_FIFO_FULL. באחריות השכבות העליונות (המתקשר) לכבות אותה, אם היא יודעת שה-AP עלול ללכת לישון. זה שימושי עבור יישומי ניהול כאשר המערכת נמצאת במצב צריכת חשמל גבוהה. פרמטרים: id - מזהה לבקשה. אפשרויות - ראה הגדרת מבנה FlpBatchOptions . ערך החזרה: FLP_RESULT_SUCCESS עם הצלחה, FLP_RESULT_INSUFFICIENT_MEMORY, FLP_RESULT_ID_EXISTS, FLP_RESULT_ERROR בכשל.

הגדרה בשורה 367 של הקובץ fused_location.h .

int(* stop_batching)(int id)

תפסיק לאסוף. פרמטרים: id - מזהה לבקשה. ערך החזרה: FLP_RESULT_SUCCESS על הצלחה, FLP_RESULT_ID_UNKNOWN או FLP_RESULT_ERROR על כישלון.

הגדרה בשורה 392 של הקובץ fused_location.h .

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

עדכן את FlpBatchOptions המשויכות לבקשת אצווה. כאשר מתבצעת פעולת אצווה ויש לעדכן אפשרות אצווה כגון FLP_BATCH_WAKEUP_ON_FIFO_FULL, ייעשה שימוש ב-API זה. לדוגמה, זה יכול לקרות כאשר ה-AP ער ויישום המפות נמצא בשימוש. פרמטרים: id - מזהה של בקשת אצווה קיימת. new_options - FlpBatchOptions מעודכן ערך החזרה: FLP_RESULT_SUCCESS עם הצלחה, FLP_RESULT_ID_UNKNOWN, FLP_RESULT_ERROR בשגיאה.

הגדרה בשורה 382 של הקובץ fused_location.h .

התיעוד עבור מבנה זה נוצר מהקובץ הבא: