Skip to content

ForecastedEvent

Source code in docs_src/capo_location/types/forecasted_event.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class ForecastedEvent(TypedDict, closed=True):
    event_id: "capo_location.types.uuid.Uuid"
    """<p>The forecasted event identifier.</p>"""
    geofence_id: "capo_location.types.id.Id"
    """<p>The geofence identifier pertaining to the forecasted event.</p>"""
    is_device_in_geofence: "bool"
    """<p>Indicates if the device is located within the geofence.</p>"""
    nearest_distance: "capo_location.types.nearest_distance.NearestDistance"
    """<p>The closest distance from the device's position to the geofence.</p>"""
    event_type: (
        "capo_location.types.forecasted_geofence_event_type.ForecastedGeofenceEventType"
    )
    """<p>The event type, forecasting three states for which a device can be in relative to a geofence:</p> <p> <code>ENTER</code>: If a device is outside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.</p> <p> <code>EXIT</code>: If a device is inside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.</p> <p> <code>IDLE</code>: If a device is inside of a geofence, and the device is not moving.</p>"""
    forecasted_breach_time: NotRequired["capo_location.types.timestamp.Timestamp"]
    """<p>The forecasted time the device will breach the geofence in <a href="https://www.iso.org/iso-8601-date-and-time-format.html">ISO 8601</a> format: <code>YYYY-MM-DDThh:mm:ss.sssZ</code> </p>"""
    geofence_properties: NotRequired["capo_location.types.property_map.PropertyMap"]
    """<p>The geofence properties.</p>"""

event_id instance-attribute 

event_id: Uuid

The forecasted event identifier.

event_type instance-attribute 

event_type: ForecastedGeofenceEventType

The event type, forecasting three states for which a device can be in relative to a geofence:

ENTER: If a device is outside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.

EXIT: If a device is inside of a geofence, but would breach the fence if the device is moving at its current speed within time horizon window.

IDLE: If a device is inside of a geofence, and the device is not moving.

forecasted_breach_time instance-attribute 

forecasted_breach_time: NotRequired[Timestamp]

The forecasted time the device will breach the geofence in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

geofence_id instance-attribute 

geofence_id: Id

The geofence identifier pertaining to the forecasted event.

geofence_properties instance-attribute 

geofence_properties: NotRequired[PropertyMap]

The geofence properties.

is_device_in_geofence instance-attribute 

is_device_in_geofence: bool

Indicates if the device is located within the geofence.

nearest_distance instance-attribute 

nearest_distance: NearestDistance

The closest distance from the device's position to the geofence.