com.swirl

Class Region

java.lang.Object

com.swirl.SObject

com.swirl.Signal

com.swirl.Region

public class Region
extends Signal

A Region represents a latitude and longitude and a radius defining a circular area with an additional optional set of points representing a polygon refinement of that circular area. There are two types of Regions in use by the library: geofence and control.

Geofences have Location and Placement associated to them and are typically created and managed by users. Control regions have no Location or Placement Objects associated to them and are used internally for controlling signal detection. For example, with Beacons control regions are used to turn on and off bluetooth scanning and to indicate which iBeacon UUIDs are nearby etc.

In order to manage very large sets of regions and to preserve battery, regions are managed in batches. The mobile device fetches a set of region metadata periodically and caches that information locally. The set of regions fetched is determined by application-key and geographical location. By default, the library fetches 1 degree of latitude and longitude's worth of region metadata and caches that on both a time basis (12 to 24 hours) and a location basis.

Field Summary

Fields inherited from class com.swirl.Signal

location, TYPE_BEACON, TYPE_GEOFENCE, TYPE_WIFI

Fields inherited from class com.swirl.SObject

properties

Constructor Summary

Constructors

Constructor and Description
Region(org.json.JSONObject info)

Method Summary

Modifier and Type	Method and Description
boolean	containsLocation(android.location.Location location) Determine if a Location is contained within the Region.
Region	copy()
double	distanceFromLocation(android.location.Location location) Compute the distance to this Region.
java.lang.Object	get(java.lang.String key)
android.location.Location	getCenter() Get the center point of the Region as an operating system Location object.
long	getLastDetected() Get the approximate range (in meters) to the center of the region
java.util.List<double[]>	getPolyCoords()
int	getPolyCount() For polygon regions, get then number of vertices in the polygon
double	getRadius() Get the radius of the region (meters).
double	getRange() Get the approximate range (in meters) to the center of the region
int	getType() Get the signal type -- always returns TYPE_GEOFENCE
boolean	hasBeacons() Determine if this Region contains beacons (control regions only)
void	setLastDetected(long ts)
java.lang.String	toString()

Methods inherited from class com.swirl.Signal

getAttachments, getAttributes, getError, getLabels, getLocation, getURN, setError

Methods inherited from class com.swirl.SObject

equals, getArray, getArray, getDouble, getIdentifier, getInt, getName, getObject, getObject, getString, getString, hashCode, setProperties

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Region

public Region(org.json.JSONObject info)

Method Detail

getType

public int getType()

Get the signal type -- always returns TYPE_GEOFENCE

Specified by:

getType in class Signal

Returns:

TYPE_GEOFENCE

getRange

public double getRange()

Get the approximate range (in meters) to the center of the region

Specified by:

getRange in class Signal

Returns:

Distance in meters

getLastDetected

public long getLastDetected()

Get the approximate range (in meters) to the center of the region

Specified by:

getLastDetected in class Signal

Returns:

Distance in meters

setLastDetected

public void setLastDetected(long ts)

getCenter

public android.location.Location getCenter()

Get the center point of the Region as an operating system Location object.

Returns:

Location

getRadius

public double getRadius()

Get the radius of the region (meters).

Returns:

radius in meters

getPolyCount

public int getPolyCount()

For polygon regions, get then number of vertices in the polygon

Returns:

Number of vertices

getPolyCoords

public java.util.List<double[]> getPolyCoords()

distanceFromLocation

public double distanceFromLocation(android.location.Location location)

Compute the distance to this Region.

Parameters:

location -

Returns:

postive values indicate outside, negative values inside

containsLocation

public boolean containsLocation(android.location.Location location)

Determine if a Location is contained within the Region.

Parameters:

location -

Returns:

true if location is inside the region and/or polygon

hasBeacons

public boolean hasBeacons()

Determine if this Region contains beacons (control regions only)

Returns:

true if the region contains beacons, false otherwise.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

get

public java.lang.Object get(java.lang.String key)

copy

public Region copy()