RegionEntity

java.lang.Object
- com.microstrategy.usher.RegionEntity

```
public abstract class RegionEntity
extends java.lang.Object
```
The RegionEntity abstract class includes various attributes about the telemetry collection geo-fences associated with the badge. If a badge resides within a telemetry collection geo-fence and requires location tracking, then the user's location will be reported to the server. This class includes various properties such as latitude, longitude, and radius of a telemetry collection geo-fence.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`distanceInMeters(double lat1, double lon1)` Returns a double of the distance in meters between the given latitude and longitude parameters and the ones associated with the `RegionEntity`.
`abstract double`	`latitude()` Returns a double of the latitudinal coordinate of the telemetry collection geo-fence.
`abstract double`	`longitude()` Returns a double of the longitudinal coordinate of the telemetry collection geo-fence.
`abstract float`	`radius()` Returns a float of the radius of the telemetry collection geo-fence in meters.
`boolean`	`withInRange(double distanceInMeters)` Returns a boolean that represents whether or not a distance is within the bounds of the radius.
`boolean`	`withInRange(double lat1, double lon1)` Returns a boolean that represents whether or not a specific latitudinal/longitudinal coordinate is within the range of a telemetry collection geo-fence.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - radius
```
public abstract float radius()
```
    Returns a float of the radius of the telemetry collection geo-fence in meters.
    
    Returns:
    
    the radius of the telemetry collection geo-fence in meters.
  - longitude
```
public abstract double longitude()
```
    Returns a double of the longitudinal coordinate of the telemetry collection geo-fence.
    
    Returns:
    
    the longitudinal coordinate of the telemetry collection geo-fence.
  - latitude
```
public abstract double latitude()
```
    Returns a double of the latitudinal coordinate of the telemetry collection geo-fence.
    
    Returns:
    
    the latitudinal coordinate of the telemetry collection geo-fence.
  - withInRange
```
public boolean withInRange(double lat1,
                           double lon1)
```
    Returns a boolean that represents whether or not a specific latitudinal/longitudinal coordinate is within the range of a telemetry collection geo-fence.
    
    Parameters:
    
    lat1 - the latitudinal coordinate
    
    lon1 - the longitudinal coordinate
    
    Returns:
    
    true if the latitudinal/longitudinal coordinate is within range of a telemetry collection geofence; false otherwise.
  - withInRange
```
public boolean withInRange(double distanceInMeters)
```
    Returns a boolean that represents whether or not a distance is within the bounds of the radius.
    
    Parameters:
    
    distanceInMeters - the distance in meters
    
    Returns:
    
    true if the distance in meters is less than the radius of the telemetry collection geo-fence; false otherwise.
  - distanceInMeters
```
public double distanceInMeters(double lat1,
                               double lon1)
```
    Returns a double of the distance in meters between the given latitude and longitude parameters and the ones associated with the RegionEntity.
    
    Parameters:
    
    lat1 - the given latitudinal coordinate
    
    lon1 - the given longitudinal coordinate
    
    Returns:
    
    the distance in meters between the given longitude and longitude and the ones associated with the RegionEntity.

Class RegionEntity

Method Summary

Methods inherited from class java.lang.Object

Method Detail

radius

longitude

latitude

withInRange

withInRange

distanceInMeters