Implementation of IGeofencingManager. Start point for interacting with Deepsy Geofencing service More...

Inheritance diagram for GeofencingManager:

Public Member Functions
	GeofencingManager (string ip)

	GeofencingManager (GeofencingDeepsyClientDealerConfiguration dealer, GeofencingDeepsyClientSubscriberConfiguration subscriber)

	GeofencingManager (int routerPort, int publishPort)

	GeofencingManager (string ip, int routerPort, int publishPort, GeofencingDeepsyClientDealerConfiguration dealer, GeofencingDeepsyClientSubscriberConfiguration subscriber)

IEnumerable< string >	GetSOGs ()
	Get every set of geofences in the database More...

IEnumerable< IGeofence >	GetGeofences (string sogId)
	Get every set of geofences in the database More...

IGeofence	AddPolygonGeofence (string sogId, int id, string name, bool enabled, IList< IPosition > positions)
	Creates a geofence in the database defined as a list of points More...

IGeofence	AddCircleGeofence (string sogId, int id, string name, bool enabled, IPosition position, int radius)
	Creates a geofence in the database defined as a point and a radius More...

IGeofence	AddBufferedLineGeofence (string sogId, int id, string name, bool enabled, IList< IPosition > positions, int radius)
	Creates a geofence in the database defined as a list of points and a radius More...

void	DeleteGeofence (IGeofence geofence)
	Deletes a geofence in the database More...

void	EnableGeofence (IGeofence geofence)
	Enables a geofence in the database More...

void	DisableGeofence (IGeofence geofence)
	Disables a geofence in the database More...

void	EnableSOG (string sogId)
	Enables all geofences from a set of geofences in the database More...

void	DisableSOG (string sogId)
	Disables all geofences from a set of geofences in the database More...

void	DeleteSOG (string sogId)
	Deletes all geofences from a set of geofences in the database More...

override void	Dispose ()

Protected Member Functions
override void	Dispose (bool disposing)

Properties
EventHandler< ServiceAvailabilityEvent >	ServiceAvailabilityEvent

EventHandler< ISogListEvent >	SogListEvent

EventHandler< IGeofenceListEvent >	GeofenceListEvent

Additional Inherited Members
Public Attributes inherited from DeepsyDisposable
bool	IsDiposed => Disposed

Protected Attributes inherited from DeepsyDisposable
bool	Disposed = false

Events inherited from IGeofencingNotifier
EventHandler< ISogListEvent >	SogListEvent
	Event raised by changes in sog list More...

EventHandler< IGeofenceListEvent >	GeofenceListEvent
	Event raised by changes in geofence list More...

Detailed Description

Member Function Documentation

IGeofence AddBufferedLineGeofence	(	string	sogId,
		int	id,
		string	name,
		bool	enabled,
		IList< IPosition >	positions,
		int	radius
	)

Parameters

sogId	Set of geofences identifier
id	ID of the geofence
name	Name of the geofence
enabled	True if the geofence is enabled
positions	List of positions of the geofence
radius	Radius of the geofence

Returns: Geofence created

Exceptions

NotAvailableException (NOT_AVAILABLE)	Thrown when service is not available
NotAvailableException (DPY_TIMEOUT)	Thrown when service don't respond in time

Implements IGeofencingManager.

IGeofence AddCircleGeofence	(	string	sogId,
		int	id,
		string	name,
		bool	enabled,
		IPosition	position,
		int	radius
	)

Parameters

sogId	Set of geofences identifier
id	ID of the geofence
name	Name of the geofence
enabled	True if the geofence is enabled
position	Center point of the geofence
radius	Radius of the geofence

Returns: Geofence created

Exceptions

NotAvailableException (NOT_AVAILABLE)	Thrown when service is not available
NotAvailableException (DPY_TIMEOUT)	Thrown when service don't respond in time

Implements IGeofencingManager.

IGeofence AddPolygonGeofence	(	string	sogId,
		int	id,
		string	name,
		bool	enabled,
		IList< IPosition >	positions
	)

Parameters

sogId	Set of geofences identifier
id	ID of the geofence
name	Name of the geofence
enabled	True if the geofence is enabled
positions	List of positions of the geofence

Returns: Geofence created

Exceptions

NotAvailableException (NOT_AVAILABLE)	Thrown when service is not available
NotAvailableException (DPY_TIMEOUT)	Thrown when service don't respond in time

Implements IGeofencingManager.

void DeleteGeofence ( IGeofence geofence )

Parameters

geofence Geofence to be deleted

Exceptions

NotAvailableException (NOT_AVAILABLE)	Thrown when service is not available
NotAvailableException (DPY_TIMEOUT)	Thrown when service don't respond in time

Implements IGeofencingManager.

void DeleteSOG ( string sogId )

Parameters

sogId Set of geofences identifier

Exceptions

NotAvailableException (NOT_AVAILABLE)	Thrown when service is not available
NotAvailableException (DPY_TIMEOUT)	Thrown when service don't respond in time

Implements IGeofencingManager.

void DisableGeofence ( IGeofence geofence )

Parameters

geofence Geofence to be disabled

Exceptions

NotAvailableException (NOT_AVAILABLE)	Thrown when service is not available
NotAvailableException (DPY_TIMEOUT)	Thrown when service don't respond in time

Implements IGeofencingManager.

void DisableSOG ( string sogId )

Parameters

sogId Set of geofences identifier

Exceptions

NotAvailableException (NOT_AVAILABLE)	Thrown when service is not available
NotAvailableException (DPY_TIMEOUT)	Thrown when service don't respond in time

Implements IGeofencingManager.

void EnableGeofence ( IGeofence geofence )

Parameters

geofence Geofence to be enabled

Exceptions

NotAvailableException (NOT_AVAILABLE)	Thrown when service is not available
NotAvailableException (DPY_TIMEOUT)	Thrown when service don't respond in time

Implements IGeofencingManager.

void EnableSOG ( string sogId )

Parameters

sogId Set of geofences identifier

Exceptions

NotAvailableException (NOT_AVAILABLE)	Thrown when service is not available
NotAvailableException (DPY_TIMEOUT)	Thrown when service don't respond in time

Implements IGeofencingManager.

IEnumerable<IGeofence> GetGeofences ( string sogId )

Returns: List of set of geofences

Exceptions

NotAvailableException (NOT_AVAILABLE)	Thrown when service is not available
NotAvailableException (DPY_TIMEOUT)	Thrown when service don't respond in time

Implements IGeofencingManager.

IEnumerable<string> GetSOGs ( )

Returns: List of set of geofences

Exceptions

NotAvailableException (NOT_AVAILABLE)	Thrown when service is not available
NotAvailableException (DPY_TIMEOUT)	Thrown when service don't respond in time

Implements IGeofencingManager.

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation