dpyGeofencing Namespace Reference

Deepsy Geofencing namespace that includes the different enums, structs or method signatures that should be used.

Classes
struct	Geofence

Typedefs
typedef boost::function< void(const bool &available)>	service_availability_handler
	Prototype of the handler function used to monitor service availability. More...
typedef boost::function< void(boost::system::error_code error_code)>	result_handler_function
	Handler for command function callback. More...
typedef boost::function< void(boost::system::error_code error_code, const std::string &ip)>	gnss_source_ip_handler_function
	Handler for get GNSS source IP requests. More...
typedef boost::function< void(boost::system::error_code error_code, std::map< int, Geofence > &geofencesMap)>	geofences_list_handler_function
	Handler for get geofences requests. More...
typedef boost::function< void(boost::system::error_code error_code, std::list< std::string > &sogsList)>	sogs_list_handler_function
	Handler for get "sets of geofences" request. More...
typedef boost::function< void(boost::system::error_code error_code, GeofenceEvent event, std::string sogid, int id, Geofence geofence, double angle)>	geofence_event_handler_function
	Handler for command function callback. More...
typedef boost::function< void(boost::system::error_code error_code, SogEvent event, std::string sogid, int id, Geofence geofence)>	sog_event_handler_function
	Handler for command function callback. More...
typedef boost::function< void(boost::system::error_code error_code, SogListEvent event, std::string sogid)>	soglist_event_handler_function
	Handler for command function callback. More...

Enumerations
enum	SogListEvent { SOG_ADDED = 0, SOG_REMOVED = 1 }
enum	SogEvent { GEOFENCE_ADDED = 0, GEOFENCE_REMOVED = 1 }
enum	GeofenceEvent {   ENTER = 0, EXIT = 1, ENTER_ENABLED = 2, EXIT_DISABLED = 3,   ENABLED = 4, DISABLED = 5 }
enum	FeedStatus { FEED_DISABLED = 0, FEED_ENABLED = 1 }

Typedef Documentation

geofence_event_handler_function

typedef boost::function<void(boost::system::error_code error_code, GeofenceEvent event, std::string sogid, int id, Geofence geofence, double angle)> geofence_event_handler_function

This type of function is called when an event ocurrs

Parameters

error_code	error code (if any)
event	ENTER or EXIT
sogid	"set of geofences" id
id	id of the geofence
geofence	geofence details
angle	bearing respect the geofence centroid

geofences_list_handler_function

typedef boost::function<void(boost::system::error_code error_code, std::map<int, Geofence> &geofencesMap)> geofences_list_handler_function

This type of function is called when server returns a map of geofences

Parameters

error_code	error code (if any)
geofencesMap	map of geofences

gnss_source_ip_handler_function

typedef boost::function<void(boost::system::error_code error_code, const std::string &ip)> gnss_source_ip_handler_function

This type of function is called when server returns the configured GNSS service IP address

Parameters

error_code	error code (if any)
ip	configured GNSS service IP address

result_handler_function

typedef boost::function<void(boost::system::error_code error_code)> result_handler_function

This type of function is called if a result is returned as error code

Parameters

error_code

error code (if any)

service_availability_handler

typedef boost::function<void(const bool &available)> service_availability_handler

Parameters

available

true if the service is available, false otherwise

sog_event_handler_function

typedef boost::function<void(boost::system::error_code error_code, SogEvent event, std::string sogid, int id, Geofence geofence)> sog_event_handler_function

This type of function is called when an event ocurrs

Parameters

error_code	error code (if any)
event	ADDED or REMOVED
sogid	"set of geofences" id
id	id of the geofence
geofence	geofence details

soglist_event_handler_function

typedef boost::function<void(boost::system::error_code error_code, SogListEvent event, std::string sogid)> soglist_event_handler_function

This type of function is called when an event ocurrs

Parameters

error_code	error code (if any)
event	ADDED or REMOVED
sogid	"set of geofences" id

sogs_list_handler_function

typedef boost::function<void(boost::system::error_code error_code, std::list<std::string> &sogsList)> sogs_list_handler_function

This type of function is called when server returns a map of geofences

Parameters

error_code	error code (if any)
sogsList	list of "set of geofences"

Enumeration Type Documentation

FeedStatus

enum FeedStatus

Custom position feed status

Enumerator
FEED_DISABLED	Custom position feed disabled.
FEED_ENABLED	Custom position feed enabled.

GeofenceEvent

enum GeofenceEvent

Event of a geofence

Enumerator
ENTER	ENTER.
EXIT	EXIT.
ENTER_ENABLED	ENTER_ENABLED.
EXIT_DISABLED	EXIT_DISABLED.
ENABLED	ENABLED.
DISABLED	DISABLED.

SogEvent

enum SogEvent

Event of a sog

Enumerator
GEOFENCE_ADDED	A geofence is added to the set.
GEOFENCE_REMOVED	A geofence is removed from the set.

SogListEvent

enum SogListEvent

Sog list event

Enumerator
SOG_ADDED	A set of geofences is added.
SOG_REMOVED	A set of geofences is removed.