Tài liệu tham khảo về cấu trúc FlpLocationInterface

Trường dữ liệu
Tài liệu tham khảo về cấu trúc FlpLocationInterface

#include < fused_location.h >

Trường dữ liệu

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

Nội dung mô tả chi tiết

Biểu thị giao diện FLP chuẩn.

Định nghĩa tại dòng 321 của tệp fused_location.h .

Tài liệu về trường

void(* cleanup)()

Đóng giao diện. Nếu có bất kỳ thao tác hàng loạt nào đang diễn ra, bạn nên dừng các thao tác đó.

Định nghĩa tại dòng 398 của tệp fused_location.h .

void(* flush_batched_locations)()

Truy xuất tất cả các vị trí theo lô hiện đang được lưu trữ và xoá vùng đệm. BẠN PHẢI gọi flp_location_callback để phản hồi, ngay cả khi không có vị trí nào cần xoá (trong trường hợp này, num_locations phải là 0). Các lệnh gọi tiếp theo đến get_batched_location hoặc flush_batched_locations không được trả về bất kỳ vị trí nào được trả về trong lệnh gọi này.

Định nghĩa tại dòng 436 của tệp fused_location.h .

int(* get_batch_size)()

Trả về kích thước lô (theo số lượng đối tượng FlpLocation ) có sẵn trong phần cứng. Xin lưu ý rằng các cách triển khai phần cứng khác nhau có thể có kích thước mẫu khác nhau. Phương thức này sẽ trả về số lượng mẫu được xác định ở định dạng FlpLocation . Lớp trên sẽ sử dụng thông tin này để quyết định khoảng thời gian tạo lô và liệu có cần đánh thức AP hay không.

Định nghĩa tại dòng 343 của tệp fused_location.h .

void(* get_batched_location)(int last_n_locations)

Lấy thông tin vị trí kết hợp đã được phân lô. flp_location_callback được dùng để trả về thông tin vị trí. Đối tượng vị trí chỉ bị loại bỏ khỏi vùng đệm khi vùng đệm đã đầy. Đừng xoá dữ liệu đó khỏi vùng đệm chỉ vì dữ liệu đó đã được trả về bằng lệnh gọi lại. Nói cách khác, khi không có đối tượng vị trí mới, hai lệnh gọi đến get_batched_location(1) sẽ trả về cùng một đối tượng vị trí. Tham số: last_n_locations – Số lượng vị trí cần lấy. Có thể là một hoặc nhiều. Nếu last_n_locations là 1, bạn sẽ nhận được vị trí mới nhất mà phần cứng biết được.

Định nghĩa tại dòng 412 của tệp fused_location.h .

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

Lấy con trỏ đến thông tin về tiện ích.

Định nghĩa tại dòng 427 của tệp fused_location.h .

int(* init)( FlpCallbacks *callbacks)

Mở giao diện và cung cấp các quy trình gọi lại để triển khai giao diện này. Sau khi được gọi, bạn nên phản hồi bằng cách gọi flp_capabilities_callback trong FlpCallbacks để chỉ định các chức năng mà phương thức triển khai của bạn hỗ trợ.

Định nghĩa tại dòng 333 của tệp fused_location.h .

int(* inject_location)( FlpLocation *location)

Chèn vị trí hiện tại từ một trình cung cấp vị trí khác, vĩ độ và kinh độ được đo bằng độ, độ chính xác dự kiến được đo bằng mét Tham số: vị trí – Đối tượng vị trí đang được chèn. Giá trị trả về: FLP_RESULT_SUCCESS hoặc FLP_RESULT_ERROR.

Định nghĩa tại dòng 422 của tệp fused_location.h .

size_t size

đặt thành sizeof(FlpLocationInterface)

Định nghĩa tại dòng 325 của tệp fused_location.h .

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

Bắt đầu tạo lô vị trí. API này chủ yếu được dùng khi AP ở trạng thái ngủ và thiết bị có thể tạo hàng loạt vị trí trong phần cứng. flp_location_callback được dùng để trả về các vị trí. Khi vùng đệm đầy và FLP_BATCH_WAKEUP_ON_FIFO_FULL được sử dụng, AP sẽ được đánh thức. Khi bộ đệm đầy và FLP_BATCH_WAKEUP_ON_FIFO_FULL không được đặt, đối tượng vị trí cũ nhất sẽ bị loại bỏ. Trong trường hợp này, AP sẽ không được đánh thức. Lớp trên sẽ sử dụng API get_batched_location để yêu cầu vị trí một cách rõ ràng. Nếu bạn đặt FLP_BATCH_CALLBACK_ON_LOCATION_FIX, thì quá trình triển khai sẽ gọi flp_location_callback mỗi khi có bản sửa lỗi vị trí. Thao tác này sẽ ghi đè chế độ cài đặt cờ FLP_BATCH_WAKEUP_ON_FIFO_FULL. Các lớp trên (phương thức gọi) có trách nhiệm tắt AP nếu biết rằng AP có thể chuyển sang trạng thái ngủ. Điều này rất hữu ích cho các ứng dụng điều hướng khi hệ thống ở chế độ tiết kiệm pin. Tham số: id – Mã nhận dạng cho yêu cầu. options – Xem định nghĩa cấu trúc FlpBatchOptions . Giá trị trả về: FLP_RESULT_SUCCESS khi thành công, FLP_RESULT_INSUFFICIENT_MEMORY, FLP_RESULT_ID_EXISTS, FLP_RESULT_ERROR khi không thành công.

Định nghĩa tại dòng 367 của tệp fused_location.h .

int(* stop_batching)(int id)

Dừng tạo lô. Tham số: id – Mã nhận dạng cho yêu cầu. Giá trị trả về: FLP_RESULT_SUCCESS khi thành công, FLP_RESULT_ID_UNKNOWN hoặc FLP_RESULT_ERROR khi không thành công.

Định nghĩa tại dòng 392 của tệp fused_location.h .

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

Cập nhật FlpBatchOptions liên kết với một yêu cầu xử lý hàng loạt. Khi một thao tác xử lý hàng loạt đang diễn ra và cần cập nhật một tuỳ chọn xử lý hàng loạt như FLP_BATCH_WAKEUP_ON_FIFO_FULL, API này sẽ được sử dụng. Ví dụ: điều này có thể xảy ra khi AP đang thức và ứng dụng bản đồ đang được sử dụng. Tham số: id – Mã của một yêu cầu hàng loạt hiện có. new_options – FlpBatchOptions mới cập nhật. Giá trị trả về: FLP_RESULT_SUCCESS khi thành công, FLP_RESULT_ID_UNKNOWN, FLP_RESULT_ERROR khi gặp lỗi.

Định nghĩa tại dòng 382 của tệp fused_location.h .

Tài liệu cho cấu trúc này được tạo từ tệp sau: