GeofenceOptions Struct Reference

GeofenceOptions Struct Reference

#include < fused_location.h >

Data Fields

int  last_transition
 
int  monitor_transitions
 
int  notification_responsivenes_ms
 
int  unknown_timer_ms
 
uint32_t  sources_to_use
 

Detailed Description

Geofence Options

Definition at line 714 of file fused_location.h .

Field Documentation

int last_transition

The current state of the geofence. For example, if the system already knows that the user is inside the geofence, this will be set to FLP_GEOFENCE_TRANSITION_ENTERED. In most cases, it will be FLP_GEOFENCE_TRANSITION_UNCERTAIN.

Definition at line 720 of file fused_location.h .

int monitor_transitions

Transitions to monitor. Bitwise OR of FLP_GEOFENCE_TRANSITION_ENTERED, FLP_GEOFENCE_TRANSITION_EXITED and FLP_GEOFENCE_TRANSITION_UNCERTAIN.

Definition at line 727 of file fused_location.h .

int notification_responsivenes_ms

Defines the best-effort description of how soon should the callback be called when the transition associated with the Geofence is triggered. For instance, if set to 1000 millseconds with FLP_GEOFENCE_TRANSITION_ENTERED, the callback should be called 1000 milliseconds within entering the geofence. This parameter is defined in milliseconds. NOTE: This is not to be confused with the rate that the GPS is polled at. It is acceptable to dynamically vary the rate of sampling the GPS for power-saving reasons; thus the rate of sampling may be faster or slower than this.

Definition at line 741 of file fused_location.h .

uint32_t sources_to_use

The sources to use for monitoring geofences. Its a BITWISE-OR of FLP_TECH_MASK flags.

Definition at line 753 of file fused_location.h .

int unknown_timer_ms

The time limit after which the UNCERTAIN transition should be triggered. This paramter is defined in milliseconds.

Definition at line 747 of file fused_location.h .


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