gem::Geofence Class Reference

Geofence object. More...

Inheritance diagram for gem::Geofence:

Collaboration diagram for gem::Geofence:

Public Member Functions
	Geofence (const Geofence &)=delete
	Geofence (Geofence &&)=default
	Default move constructor noexcept is deduced.
Geofence &	operator= (const Geofence &)=delete
Geofence &	operator= (Geofence &&navService)=default
	Default move assignment noexcept is deduced.
int	addArea (const GeographicArea &area, const String &id, const ParameterList &meta, ProgressListener listener) noexcept
	Add a geographic area to the geofence.
int	addAreas (const GeofenceAreaList &areas, ProgressListener listener) noexcept
	Add list of geographic areas to the geofence.
int	getAreas (GeofenceAreaList &areas, const StringList &ids, ProgressListener listener, const ParameterList &meta={}) noexcept
	Get the geographic areas list filtered by id and meta data.
int	removeAreas (const StringList &ids, ProgressListener listener, const ParameterList &meta={}) noexcept
	Remove a geographic area, identified by id, from the geofence.
int	getProximityAreas (GeofenceProximityAreaList &proxAreas, const Coordinates &coords, int radius, ProgressListener listener, int details=0) noexcept
	Get geofence proximity areas for the given coordinates & radius.
void	cancel (ProgressListener listener) noexcept
	Cancel an asynchronous operation.
int	startMonitoring (GeofenceListener listener, const StringList &ids=StringList()) noexcept
	Start the monitoring for the given areas.
int	startMonitoring (GeofenceListener listener, LargeInteger userId) noexcept
	Start the monitoring for the given user.
int	stopMonitoring (GeofenceListener listener) noexcept
	Stop the monitoring for the given areas.

Detailed Description

Geofence object.

Implements share-read / write Api object over IGeofence.

This behaves like a singleton, i.e. all instances are shared behind the same API interface

Member Function Documentation

addArea()

int gem::Geofence::addArea ( const GeographicArea & area, const String & id, const ParameterList & meta, ProgressListener listener )

inlinenoexcept

Add a geographic area to the geofence.

Parameters

[in]	area	The geographic area to be monitored
[in]	id	The area unique identifier. Must be unique in the geofence areas collection
[in]	meta	A list of parameters which compose the metadata.
[in]	listener	The operation progress listener

Returns

The operation error code

addAreas()

int gem::Geofence::addAreas ( const GeofenceAreaList & areas, ProgressListener listener )

inlinenoexcept

Add list of geographic areas to the geofence.

Parameters

[in]	areas	The geofence area list to be monitored
[in]	listener	The operation progress listener

Returns

The operation error code

cancel()

void gem::Geofence::cancel ( ProgressListener listener )

inlinenoexcept

Cancel an asynchronous operation.

Parameters

[in]

listener

The observer used to start the operation

getAreas()

int gem::Geofence::getAreas ( GeofenceAreaList & areas, const StringList & ids, ProgressListener listener, const ParameterList & meta = {} )

inlinenoexcept

Get the geographic areas list filtered by id and meta data.

Parameters

[in]	areas	The areas list result, will be fully populated on IProgressListener::notifyComplete
[in]	listener	The operation progress listener
[in]	ids	The unique identifiers of the areas to filter. If empty, no ids filter is applied
[in]	meta	The meta data to filter the search.

A result will match if filter meta data key = geofence meta data key and filter meta data value = geofence meta data value

If empty, no meta data filter is applied

Returns

The operation error code

getProximityAreas()

int gem::Geofence::getProximityAreas ( GeofenceProximityAreaList & proxAreas, const Coordinates & coords, int radius, ProgressListener listener, int details = 0 )

inlinenoexcept

Get geofence proximity areas for the given coordinates & radius.

Parameters

[in]	proxAreas	The proximity areas list result, will be fully populated on IProgressListener::notifyComplete
[in]	coords	The coordinates reference for search
[in]	radius	The search radius around the reference coordinates
[in]	listener	The operation progress listener
[in]	details	The GeofenceArea result details. A combination of ProximityAreaDetails options, default = 0 meaning only GeofenceArea::id will be available in the result

Returns

The operation error code

operator=()

Geofence & gem::Geofence::operator= ( Geofence && navService )

default

Default move assignment noexcept is deduced.

Returns

A reference to this object

Parameters

[in]

navService

The object to be moved

removeAreas()

int gem::Geofence::removeAreas ( const StringList & ids, ProgressListener listener, const ParameterList & meta = {} )

inlinenoexcept

Remove a geographic area, identified by id, from the geofence.

Parameters

[in]	ids	The areas unique identifiers. If empty, all areas will be delete from the geofence
[in]	listener	The operation progress listener
[in]	meta	The meta data to filter the search.

Returns

The operation error code

startMonitoring() [1/2]

int gem::Geofence::startMonitoring ( GeofenceListener listener, const StringList & ids = StringList() )

inlinenoexcept

Start the monitoring for the given areas.

Parameters

[in]	listener	The geofence type listener which will receive the monitor events
[in]	ids	The monitored area ids list. If empty, the listener will monitor all geofence areas

If the listener is already monitoring, the monitored filters will be updated

Returns

The operation error code

startMonitoring() [2/2]

int gem::Geofence::startMonitoring ( GeofenceListener listener, LargeInteger userId )

inlinenoexcept

Start the monitoring for the given user.

Parameters

[in]	listener	The geofence type listener which will receive the monitor events
[in]	userId	The monitored user id

If the listener is already monitoring, the monitored filters will be updated

Returns

The operation error code

stopMonitoring()

int gem::Geofence::stopMonitoring ( GeofenceListener listener )

inlinenoexcept

Stop the monitoring for the given areas.

Parameters

[in]

listener

The geofence listener for which to stop the monitoring

Returns

The operation error code