PickMapContentResult.TrafficIncidentResult (API Reference)
Class PickMapContentResult.TrafficIncidentResult
- All Implemented Interfaces:
TrafficIncidentBase
- Enclosing class:
- PickMapContentResult
Carries the result of picking a Carto traffic incident object.
Description of incident is currently not present in our map data, so
TrafficIncidentBase.getDescription() always returns an empty string.
-
Method Summary
Modifier and TypeMethodDescriptionGets the geographic coordinates of the traffic incident.Gets the human readable description of the incident, possibly with location information.Get the time until which the incident is valid, after this time the incident should not be considered.Gets the impact of the incident.Gets the unique traffic event ID.Gets the time from which the incident is valid, before this time the incident should not be considered.getType()Gets the category of the incident.
-
Method Details
-
getOriginalId
Gets the unique traffic event ID.
Can be referenced when checking for updated traffic information for the specified event.
- Returns:
Unique traffic event ID.
-
getCoordinates
Gets the geographic coordinates of the traffic incident.
- Returns:
The geographic coordinates of the traffic incident.
-
getImpact
Gets the impact of the incident.
The value is
TrafficIncidentImpact.UNKNOWNif it hasn't been provided by the traffic incidents supplier.- Specified by:
getImpactin interfaceTrafficIncidentBase- Returns:
The impact of the incident.
-
getType
Gets the category of the incident.
The value is
TrafficIncidentType.UNKNOWNif it hasn't been provided by the traffic incidents supplier.- Specified by:
getTypein interfaceTrafficIncidentBase- Returns:
The category of the incident.
-
getDescription
Gets the human readable description of the incident, possibly with location information.
The description is currently not present in our map data. Therefore, when accessing the data from a picked carto POI via
TrafficIncidentResult, then always an empty string is returned. This does not apply when using theTrafficEngine.- Specified by:
getDescriptionin interfaceTrafficIncidentBase- Returns:
The human readable description of the incident, possibly with location information.
-
getStartTime
Gets the time from which the incident is valid, before this time the incident should not be considered.
The value is
nullif it hasn't been provided by the traffic incidents supplier.- Specified by:
getStartTimein interfaceTrafficIncidentBase- Returns:
The time from which the incident is valid, before this time the incident should not be considered.
-
getEndTime
Get the time until which the incident is valid, after this time the incident should not be considered.
The value is
nullif it hasn't been provided by the traffic incidents supplier.- Specified by:
getEndTimein interfaceTrafficIncidentBase- Returns:
The time until which the incident is valid, after this time the incident should not be considered.
-