/AWS1/CL_LOCFORECASTEDEVENT¶
A forecasted event represents a geofence event in relation to the requested device state, that may occur given the provided device state and time horizon.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_eventid TYPE /AWS1/LOCUUID /AWS1/LOCUUID¶
The forecasted event identifier.
iv_geofenceid TYPE /AWS1/LOCID /AWS1/LOCID¶
The geofence identifier pertaining to the forecasted event.
iv_isdeviceingeofence TYPE /AWS1/LOCBOOLEAN /AWS1/LOCBOOLEAN¶
Indicates if the device is located within the geofence.
iv_nearestdistance TYPE /AWS1/RT_DOUBLE_AS_STRING /AWS1/RT_DOUBLE_AS_STRING¶
The closest distance from the device's position to the geofence.
iv_eventtype TYPE /AWS1/LOCFCEDGEOFENCEEVENTTYPE /AWS1/LOCFCEDGEOFENCEEVENTTYPE¶
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.
Optional arguments:¶
iv_forecastedbreachtime TYPE /AWS1/LOCTIMESTAMP /AWS1/LOCTIMESTAMP¶
The forecasted time the device will breach the geofence in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
it_geofenceproperties TYPE /AWS1/CL_LOCPROPERTYMAP_W=>TT_PROPERTYMAP TT_PROPERTYMAP¶
The geofence properties.
Queryable Attributes¶
EventId¶
The forecasted event identifier.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EVENTID() |
Getter for EVENTID, with configurable default |
ASK_EVENTID() |
Getter for EVENTID w/ exceptions if field has no value |
HAS_EVENTID() |
Determine if EVENTID has a value |
GeofenceId¶
The geofence identifier pertaining to the forecasted event.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_GEOFENCEID() |
Getter for GEOFENCEID, with configurable default |
ASK_GEOFENCEID() |
Getter for GEOFENCEID w/ exceptions if field has no value |
HAS_GEOFENCEID() |
Determine if GEOFENCEID has a value |
IsDeviceInGeofence¶
Indicates if the device is located within the geofence.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ISDEVICEINGEOFENCE() |
Getter for ISDEVICEINGEOFENCE, with configurable default |
ASK_ISDEVICEINGEOFENCE() |
Getter for ISDEVICEINGEOFENCE w/ exceptions if field has no |
HAS_ISDEVICEINGEOFENCE() |
Determine if ISDEVICEINGEOFENCE has a value |
NearestDistance¶
The closest distance from the device's position to the geofence.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NEARESTDISTANCE() |
Getter for NEARESTDISTANCE |
ASK_NEARESTDISTANCE() |
Getter for NEARESTDISTANCE w/ exceptions if field has no val |
STR_NEARESTDISTANCE() |
String format for NEARESTDISTANCE |
EventType¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EVENTTYPE() |
Getter for EVENTTYPE, with configurable default |
ASK_EVENTTYPE() |
Getter for EVENTTYPE w/ exceptions if field has no value |
HAS_EVENTTYPE() |
Determine if EVENTTYPE has a value |
ForecastedBreachTime¶
The forecasted time the device will breach the geofence in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_FORECASTEDBREACHTIME() |
Getter for FORECASTEDBREACHTIME, with configurable default |
ASK_FORECASTEDBREACHTIME() |
Getter for FORECASTEDBREACHTIME w/ exceptions if field has n |
HAS_FORECASTEDBREACHTIME() |
Determine if FORECASTEDBREACHTIME has a value |
GeofenceProperties¶
The geofence properties.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_GEOFENCEPROPERTIES() |
Getter for GEOFENCEPROPERTIES, with configurable default |
ASK_GEOFENCEPROPERTIES() |
Getter for GEOFENCEPROPERTIES w/ exceptions if field has no |
HAS_GEOFENCEPROPERTIES() |
Determine if GEOFENCEPROPERTIES has a value |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_FORECASTEDEVENTSLIST¶
TYPES TT_FORECASTEDEVENTSLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_LOCFORECASTEDEVENT WITH DEFAULT KEY
.