ST / GPS_Provider

An extension of original API for working with GPS devices.

Dependents:   A_TeseoLocationNEW A_TeseoLocation TeseoLocation

Embed: (wiki syntax)

« Back to documentation index

GPSGeofence Class Reference
Public Member Functions

GPSGeofence Class Reference

For more information about Geofence, please refer to Teseo LIV-3F UM available at st.com. More...

#include <GPSGeofence.h>

Public Member Functions

 GPSGeofence ()
 Construct a GPSGeofence instance.
 GPSGeofence (const GeofenceCircle_t &geofenceCircle)
 Construct a GPSGeofence instance.
void setGeofenceCircle (const GeofenceCircle_t &geofenceCircle)
 Set the Geofence area.
void updateGeofenceCircleStatus (int status)
 Update the status of a Geofence area.
const GeofenceCircle_t & getGeofenceCircle (void)
 Get the Geofence area.
virtual void setExpirationDuration (long durationMillis)
 Set the expiration duration of geofence.
virtual void setNotificationResponsiveness (int notificationResponsivenessMs)
 Set the best-effort notification responsiveness of the geofence.
virtual void setTransitionTypes (int transitionTypes)
 Set the transition types of interest.

Detailed Description

For more information about Geofence, please refer to Teseo LIV-3F UM available at st.com.

Definition at line 46 of file GPSGeofence.h.

Constructor & Destructor Documentation

GPSGeofence (  )

Construct a GPSGeofence instance.

Definition at line 64 of file GPSGeofence.h.

GPSGeofence ( const GeofenceCircle_t &  geofenceCircle )

Construct a GPSGeofence instance.

Definition at line 73 of file GPSGeofence.h.

Member Function Documentation

const GeofenceCircle_t& getGeofenceCircle ( void   )

Get the Geofence area.

Definition at line 108 of file GPSGeofence.h.

virtual void setExpirationDuration ( long  durationMillis ) [virtual]

Set the expiration duration of geofence.

Definition at line 115 of file GPSGeofence.h.

void setGeofenceCircle ( const GeofenceCircle_t &  geofenceCircle )

Set the Geofence area.

Definition at line 83 of file GPSGeofence.h.

virtual void setNotificationResponsiveness ( int  notificationResponsivenessMs ) [virtual]

Set the best-effort notification responsiveness of the geofence.

Definition at line 122 of file GPSGeofence.h.

virtual void setTransitionTypes ( int  transitionTypes ) [virtual]

Set the transition types of interest.

Definition at line 129 of file GPSGeofence.h.

void updateGeofenceCircleStatus ( int  status )

Update the status of a Geofence area.

Status can be one of the following:

  • Inside
  • Outside
  • Boundary
  • Unknown

Definition at line 101 of file GPSGeofence.h.

Generated on Wed Jul 13 2022 20:11:37 by  doxygen 1.7.2