com.atakmap.android.geofence.data

Class GeoFence

java.lang.Object

com.atakmap.android.geofence.data.GeoFence

public class GeoFence
extends java.lang.Object

Wraps a shape to create a Geo Fence

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GeoFence.MonitoredTypes Enumerate supported categories for monitored map items Only CoT atoms (a-*) are currently supported
static class	GeoFence.Trigger Enumerate trigger types

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_ENTRY_RADIUS_KM
static int	MAX_ELEVATION
static int	MAX_ENTRY_RADIUS_KM
static int	MIN_ELEVATION

Constructor Summary

Constructors

Constructor and Description
GeoFence(MapItem mapItem, boolean tracking, GeoFence.Trigger trigger, GeoFence.MonitoredTypes monitoredTypes, int rangeKM) ctor creates fence based on height of the provided shape
GeoFence(MapItem mapItem, boolean tracking, GeoFence.Trigger trigger, GeoFence.MonitoredTypes monitoredTypes, int rangeKM, double minElevation, double maxElevation)
GeoFence(MapItem mapItem, int rangeKM)

Method Summary

Modifier and Type	Method and Description
static void	clearGeofenceState(MapView mapView, MapItem mapItem) Unsets all of the map item variables in order to correctly remove the geofence.
boolean	equals(java.lang.Object o)
static GeoFence	fromCot(CotEvent from) Deprecated.
static GeoFence	fromMapItem(MapItem mapItem) Create A GeoFence from the mapItem
java.lang.String	getMapItemUid()
double	getMaxElevation()
double	getMinElevation()
GeoFence.MonitoredTypes	getMonitoredTypes()
int	getRangeKM() Number of KM to monitor (radius from shape center point) for TriggerTypes.Entry.
GeoFence.Trigger	getTrigger()
int	hashCode()
boolean	isElevationMonitored()
boolean	isTracking()
boolean	isValid()
void	setElevationRange(double minAlt, double maxAlt)
void	setMonitoredTypes(GeoFence.MonitoredTypes _monitoredTypes)
void	setRangeKM(int rangeKM) Set the maximum range for consideration of any of the tests (enter or exit)
void	setTracking(boolean tracking)
void	setTrigger(GeoFence.Trigger trigger)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ENTRY_RADIUS_KM

public static final int DEFAULT_ENTRY_RADIUS_KM

See Also:

Constant Field Values

MAX_ENTRY_RADIUS_KM

public static final int MAX_ENTRY_RADIUS_KM

See Also:

Constant Field Values

MIN_ELEVATION

public static final int MIN_ELEVATION

See Also:

Constant Field Values

MAX_ELEVATION

public static final int MAX_ELEVATION

See Also:

Constant Field Values

Constructor Detail

GeoFence

public GeoFence(MapItem mapItem,
                boolean tracking,
                GeoFence.Trigger trigger,
                GeoFence.MonitoredTypes monitoredTypes,
                int rangeKM)

ctor creates fence based on height of the provided shape

Parameters:

mapItem - the map item to fence on

tracking - if it is currently being considered

trigger - the trigger for the geofence

monitoredTypes - the monitor type

rangeKM - (kilometers)

GeoFence

public GeoFence(MapItem mapItem,
                int rangeKM)

GeoFence

public GeoFence(MapItem mapItem,
                boolean tracking,
                GeoFence.Trigger trigger,
                GeoFence.MonitoredTypes monitoredTypes,
                int rangeKM,
                double minElevation,
                double maxElevation)

Method Detail

getMonitoredTypes

public GeoFence.MonitoredTypes getMonitoredTypes()

setMonitoredTypes

public void setMonitoredTypes(GeoFence.MonitoredTypes _monitoredTypes)

getMapItemUid

public java.lang.String getMapItemUid()

isTracking

public boolean isTracking()

setTracking

public void setTracking(boolean tracking)

isElevationMonitored

public boolean isElevationMonitored()

getTrigger

public GeoFence.Trigger getTrigger()

setTrigger

public void setTrigger(GeoFence.Trigger trigger)

getRangeKM

public int getRangeKM()

Number of KM to monitor (radius from shape center point) for TriggerTypes.Entry. Used at initiation of monitoring to determine which map items to track

Returns:

the number of kilometers

setRangeKM

public void setRangeKM(int rangeKM)

Set the maximum range for consideration of any of the tests (enter or exit)

Parameters:

rangeKM - the range in kilometers

getMinElevation

public double getMinElevation()

getMaxElevation

public double getMaxElevation()

setElevationRange

public void setElevationRange(double minAlt,
                              double maxAlt)

isValid

public boolean isValid()

clearGeofenceState

public static void clearGeofenceState(MapView mapView,
                                      MapItem mapItem)

Unsets all of the map item variables in order to correctly remove the geofence.

fromMapItem

public static GeoFence fromMapItem(MapItem mapItem)

Create A GeoFence from the mapItem

fromCot

@Deprecated
public static GeoFence fromCot(CotEvent from)

Deprecated.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object