GeoFenceMonitor

java.lang.Object
- com.atakmap.android.geofence.monitor.GeoFenceMonitor

Direct Known Subclasses:: ClosedShapeGeoFenceMonitor

public abstract class GeoFenceMonitor
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`GeoFenceMonitor.Factory` Factory to create proper monitor, based on Map Item Map Item should be the reference shape (see GeoFenceReceiver.getReferenceShape)

Field Summary

Fields
Modifier and Type	Field and Description
`protected MapItem`	`_item` Shape e.g.
`protected java.util.Map<java.lang.String,java.lang.Boolean>`	`_uidsLastState` Map item UID to last state (true=inside fence, false=outside fence) Note, currently used for TriggerType.Both to see if an item entered or exited
`protected MapView`	`_view`

Constructor Summary

Constructors
Constructor and Description

GeoFenceMonitor(MapView view, GeoFence fence, MapItem item)

Constructors
Constructor and Description
`GeoFenceMonitor(MapView view, GeoFence fence, MapItem item)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addItem(PointMapItem item)`
`java.util.List<GeoFenceAlerting.Alert>`	`check()` Check if any tracked items have breached the Geo Fence
`protected java.util.List<GeoFenceAlerting.Alert>`	`check(GeoFence.Trigger trigger)` Check if any tracked items have breached the Geo Fence
`protected abstract java.util.List<GeoFenceAlerting.Alert>`	`check(GeoFence.Trigger trigger, java.util.List<PointMapItem> items, boolean bCheckPrevious)` Check if any tracked items have breached the Geo Fence All items passed in so subclasses can optimize shape comparison math
`protected boolean`	`checkDismissed(PointMapItem item)` Subclasses should invoke this for each item to see if user has already dismissed these alerts
`boolean`	`checkSelectedItem(PointMapItem item)`
`protected static boolean`	`checkTrigger(GeoFence.Trigger trigger, boolean bInside)` Check if we should trigger
`protected static boolean`	`checkTrigger(GeoFence.Trigger trigger, boolean bInside, java.lang.Boolean bPreviouslyInside)` Check if we should trigger.
`void`	`clearSelectItems()`
`void`	`clearUidsLastState()`
`void`	`dispose()`
`boolean`	`equals(java.lang.Object o)`
`abstract GeoPointMetaData`	`getCenter()` Get center of monitored area
`GeoFence`	`getFence()`
`abstract double`	`getfurthestPointRange()`
`MapItem`	`getItem()`
`java.util.List<PointMapItem>`	`getItems()` Get items to track/compare
`protected boolean`	`getLastState(java.lang.String uid)` Get previous state for the specified UID
`java.lang.String`	`getMapItemUid()` Get UID of the Map item which identifies this GeoFence This class caches the shape (e.g.
`java.util.List<PointMapItem>`	`getRescanItems()` Default impl return entire list based on MonitoredTypes
`java.util.ArrayList<java.lang.String>`	`getSelectedItemUids()`
`int`	`hashCode()`
`boolean`	`hasTrackedItems()`
`protected boolean`	`inElevationRange(GeoPoint point)`
`boolean`	`isMonitoring(PointMapItem item)`
`boolean`	`isValid()`
`void`	`persist()` Persist this monitor via its metadata item
`boolean`	`removeItem(PointMapItem item)` Remove tracking for the dismissed item
`void`	`setFence(GeoFence fence)`
`void`	`setSelectItems(java.util.List<PointMapItem> items)` Special handling for Self marker b/c it doesn't have a type and does not show up in the Overlay Manager for selection by user
`void`	`setSelectUids(java.util.List<java.lang.String> uids)` List of UIDs to track that have yet to be resolved
`void`	`setUidsLastState(java.util.Map<java.lang.String,java.lang.Boolean> uidsLastState)`
`int`	`size()`
`java.lang.String`	`toString()`

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

- Field Detail
  - _item
```
protected final MapItem _item
```
    Shape e.g. Circle, Rectangle, DrawingShape
  - _view
```
protected final MapView _view
```
  - _uidsLastState
```
protected final java.util.Map<java.lang.String,java.lang.Boolean> _uidsLastState
```
    Map item UID to last state (true=inside fence, false=outside fence) Note, currently used for TriggerType.Both to see if an item entered or exited
- Constructor Detail
  - GeoFenceMonitor
```
public GeoFenceMonitor(MapView view,
                       GeoFence fence,
                       MapItem item)
```
- Method Detail
  - check
```
public java.util.List<GeoFenceAlerting.Alert> check()
```
    Check if any tracked items have breached the Geo Fence
    
    Returns:
    
    the list of alerts for items that have breached the geofence
  - check
```
protected java.util.List<GeoFenceAlerting.Alert> check(GeoFence.Trigger trigger)
```
    Check if any tracked items have breached the Geo Fence
    
    Parameters:
    
    trigger - the trigger to be used
    
    Returns:
    
    the list of alerts for the items that have breached the geofence
  - check
```
protected abstract java.util.List<GeoFenceAlerting.Alert> check(GeoFence.Trigger trigger,
                                                                java.util.List<PointMapItem> items,
                                                                boolean bCheckPrevious)
```
    Check if any tracked items have breached the Geo Fence All items passed in so subclasses can optimize shape comparison math
    
    Parameters:
    
    trigger - the trigger to be used
    
    items - the list of items
    
    bCheckPrevious - if true, only alert if current state differs from previous state
    
    Returns:
  - getCenter
```
public abstract GeoPointMetaData getCenter()
```
    Get center of monitored area
  - getfurthestPointRange
```
public abstract double getfurthestPointRange()
```
  - checkDismissed
```
protected boolean checkDismissed(PointMapItem item)
```
    Subclasses should invoke this for each item to see if user has already dismissed these alerts
    
    Parameters:
    
    item - the item
    
    Returns:
    
    true if the items alert has been previously dismissed
  - isValid
```
public boolean isValid()
```
  - 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
  - dispose
```
public void dispose()
```
  - getMapItemUid
```
public java.lang.String getMapItemUid()
```
    Get UID of the Map item which identifies this GeoFence This class caches the shape (e.g. Rectangle or Rings) But the UID may be the shapes UID (rectangle) or the shape's center marker UID (circle) See GeoFenceReceiver.onReceive for more info
    
    Returns:
    
    the uid of the geofence.
  - getItem
```
public MapItem getItem()
```
  - persist
```
public void persist()
```
    Persist this monitor via its metadata item
  - setUidsLastState
```
public void setUidsLastState(java.util.Map<java.lang.String,java.lang.Boolean> uidsLastState)
```
  - clearUidsLastState
```
public void clearUidsLastState()
```
  - setSelectItems
```
public void setSelectItems(java.util.List<PointMapItem> items)
```
    Special handling for Self marker b/c it doesn't have a type and does not show up in the Overlay Manager for selection by user
    
    Parameters:
    
    items - the list of items
  - clearSelectItems
```
public void clearSelectItems()
```
  - setSelectUids
```
public void setSelectUids(java.util.List<java.lang.String> uids)
```
    List of UIDs to track that have yet to be resolved
    
    Parameters:
    
    uids - UIDs to track
  - checkSelectedItem
```
public boolean checkSelectedItem(PointMapItem item)
```
  - getSelectedItemUids
```
public java.util.ArrayList<java.lang.String> getSelectedItemUids()
```
  - hasTrackedItems
```
public boolean hasTrackedItems()
```
  - getItems
```
public java.util.List<PointMapItem> getItems()
```
    Get items to track/compare
    
    Returns:
    
    an immuatable copy list (may not be modified, but will not throw ConcurrentModificationException for iteration
  - size
```
public int size()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - setFence
```
public void setFence(GeoFence fence)
```
  - getFence
```
public GeoFence getFence()
```
  - removeItem
```
public boolean removeItem(PointMapItem item)
```
    Remove tracking for the dismissed item
    
    Parameters:
    
    item -
    
    Returns:
    
    true if this is the last item being tracked
  - isMonitoring
```
public boolean isMonitoring(PointMapItem item)
```
  - addItem
```
public boolean addItem(PointMapItem item)
```
  - checkTrigger
```
protected static boolean checkTrigger(GeoFence.Trigger trigger,
                                      boolean bInside)
```
    Check if we should trigger
    
    Parameters:
    
    trigger -
    
    bInside -
    
    Returns:
  - checkTrigger
```
protected static boolean checkTrigger(GeoFence.Trigger trigger,
                                      boolean bInside,
                                      java.lang.Boolean bPreviouslyInside)
```
    Check if we should trigger. Do not re-trigger, based on previous state
    
    Parameters:
    
    trigger -
    
    bInside -
    
    bPreviouslyInside -
    
    Returns:
  - getLastState
```
protected boolean getLastState(java.lang.String uid)
```
    Get previous state for the specified UID
    
    Parameters:
    
    uid - Item UID
  - getRescanItems
```
public java.util.List<PointMapItem> getRescanItems()
```
    Default impl return entire list based on MonitoredTypes
    
    Returns:
    
    an immuatable copy list (may not be modified, but will not throw ConcurrentModificationException for iteration
  - inElevationRange
```
protected boolean inElevationRange(GeoPoint point)
```

Class GeoFenceMonitor

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_item

_view

_uidsLastState

Constructor Detail

GeoFenceMonitor

Method Detail

check

check

check

getCenter

getfurthestPointRange

checkDismissed

isValid

equals

hashCode

dispose

getMapItemUid

getItem

persist

setUidsLastState

clearUidsLastState

setSelectItems

clearSelectItems

setSelectUids

checkSelectedItem

getSelectedItemUids

hasTrackedItems

getItems

size

toString

setFence

getFence

removeItem

isMonitoring

addItem

checkTrigger

checkTrigger

getLastState

getRescanItems

inElevationRange