FlpGeofencingInterface Struct Reference

Data Fields
FlpGeofencingInterface Struct Reference

#include < fused_location.h >

Data Fields

size_t  size
 
void(*  init )( FlpGeofenceCallbacks *callbacks)
 
void(*  add_geofences )(int32_t number_of_geofences, Geofence **geofences)
 
void(*  pause_geofence )(int32_t geofence_id)
 
void(*  resume_geofence )(int32_t geofence_id, int monitor_transitions)
 
void(*  modify_geofence_option )(int32_t geofence_id, GeofenceOptions *options)
 
void(*  remove_geofences )(int32_t number_of_geofences, int32_t *geofence_id)
 

Detailed Description

Extended interface for FLP_Geofencing support

Definition at line 764 of file fused_location.h .

Field Documentation

void(* add_geofences)(int32_t number_of_geofences, Geofence **geofences)

Add a list of geofences. Parameters: number_of_geofences - The number of geofences that needed to be added. geofences - Pointer to array of pointers to Geofence structure.

Definition at line 782 of file fused_location.h .

void(* init)( FlpGeofenceCallbacks *callbacks)

Opens the geofence interface and provides the callback routines to the implemenation of this interface. Once called you should respond by calling the flp_capabilities_callback in FlpGeofenceCallbacks to specify the capabilities that your implementation supports.

Definition at line 774 of file fused_location.h .

void(* modify_geofence_option)(int32_t geofence_id, GeofenceOptions *options)

Modify a particular geofence option. Parameters: geofence_id - The id for the geofence. options - Various options associated with the geofence. See GeofenceOptions structure for details.

Definition at line 810 of file fused_location.h .

void(* pause_geofence)(int32_t geofence_id)

Pause monitoring a particular geofence. Parameters: geofence_id - The id for the geofence.

Definition at line 789 of file fused_location.h .

void(* remove_geofences)(int32_t number_of_geofences, int32_t *geofence_id)

Remove a list of geofences. After the function returns, no notifications should be sent. Parameter: number_of_geofences - The number of geofences that needed to be added. geofence_id - Pointer to array of geofence_ids to be removed.

Definition at line 819 of file fused_location.h .

void(* resume_geofence)(int32_t geofence_id, int monitor_transitions)

Resume monitoring a particular geofence. Parameters: geofence_id - The id for the geofence. monitor_transitions - Which transitions to monitor. Bitwise OR of FLP_GEOFENCE_TRANSITION_ENTERED, FLP_GEOFENCE_TRANSITION_EXITED and FLP_GEOFENCE_TRANSITION_UNCERTAIN. This supersedes the value associated provided in the add_geofence_area call.

Definition at line 801 of file fused_location.h .

size_t size

set to sizeof(FlpGeofencingInterface)

Definition at line 766 of file fused_location.h .

The documentation for this struct was generated from the following file: