SetOfGeofences Interface Reference
Interface that represents a set of geofences. More...
Inheritance diagram for SetOfGeofences:
Public Member Functions | |
| String | getId () |
| List< Geofence > | getGeofences () throws GeofencingNotAvailableException, GeofencingLowLevelException |
| GeofenceCircle | addCircle (int id, String name, Boolean enabled, Point center, int radius) throws GeofencingNotAvailableException, GeofencingLowLevelException |
| GeofenceBufferedLine | addBufferedLine (int id, String name, Boolean enabled, List< Point > points, int radius) throws GeofencingNotAvailableException, GeofencingLowLevelException |
| GeofencePolygon | addPolygon (int id, String name, Boolean enabled, List< Point > points) throws GeofencingNotAvailableException, GeofencingLowLevelException |
| void | removeGeofence (Geofence geofence) throws GeofencingNotAvailableException, GeofencingLowLevelException |
 Public Member Functions inherited from Subject< T extends Observer< U, U extends Event > | |
| void | subscribe (T observer) throws CannotSubscribeException |
| void | unSubscribe (T observer) throws ObserverNotSubscribedException |
Detailed Description
Interface that represents a set of geofences
Member Function Documentation
| GeofenceBufferedLine addBufferedLine | ( | int | id, |
| String | name, | ||
| Boolean | enabled, | ||
| List< Point > | points, | ||
| int | radius | ||
| ) | throws GeofencingNotAvailableException, GeofencingLowLevelException |
Adds a buffered line geofence in the set
- Parameters
-
id id of the geofence name name of the geofence enabled true if geofence is enabled points list of points that defines the line radius radius of the buffer
- Returns
- GeofenceBufferedLine object
- Exceptions
-
GeofencingNotAvailableException GeofencingLowLevelException
| GeofenceCircle addCircle | ( | int | id, |
| String | name, | ||
| Boolean | enabled, | ||
| Point | center, | ||
| int | radius | ||
| ) | throws GeofencingNotAvailableException, GeofencingLowLevelException |
Adds a circle geofence in the set
- Parameters
-
id id of the geofence name name of the geofence enabled true if geofence is enabled center center of the geofence radius radius of the geofence
- Returns
- GeofenceCircle object
- Exceptions
-
GeofencingNotAvailableException GeofencingLowLevelException
| GeofencePolygon addPolygon | ( | int | id, |
| String | name, | ||
| Boolean | enabled, | ||
| List< Point > | points | ||
| ) | throws GeofencingNotAvailableException, GeofencingLowLevelException |
Adds a polygon geofence in the set
- Parameters
-
id id of the geofence name name of the geofence enabled true if geofence is enabled points list of points that defines the polygon
- Returns
- GeofencePolygon object
- Exceptions
-
GeofencingNotAvailableException GeofencingLowLevelException
| List<Geofence> getGeofences | ( | ) | throws GeofencingNotAvailableException, GeofencingLowLevelException |
Returns list of geofences contained in the set
- Returns
- list of geofences contained in the set
- Exceptions
-
GeofencingNotAvailableException GeofencingLowLevelException
| String getId | ( | ) |
Returns "set of geofences" id
- Returns
| void removeGeofence | ( | Geofence | geofence | ) | throws GeofencingNotAvailableException, GeofencingLowLevelException |
Removes a geofence from the set
- Parameters
-
geofence geofence to be removed
- Exceptions
-
GeofencingNotAvailableException GeofencingLowLevelException
