Interface TrafficIncidentBase

All Known Implementing Classes:
PickMapContentResult.TrafficIncidentResult, TrafficIncident, TrafficIncidentOnRoute

public interface TrafficIncidentBase

TrafficIncident provides details about a traffic incident.

  • Method Summary

    Modifier and Type
    Method
    Description
    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 time from which the incident is valid, before this time the incident should not be considered.
    Gets the category of the incident.
  • Method Details

    • getImpact

      @NonNull TrafficIncidentImpact getImpact()

      Gets the impact of the incident.

      The value is TrafficIncidentImpact.UNKNOWN if it hasn't been provided by the traffic incidents supplier.

      Returns:

      The impact of the incident.

    • getType

      @NonNull TrafficIncidentType getType()

      Gets the category of the incident.

      The value is TrafficIncidentType.UNKNOWN if it hasn't been provided by the traffic incidents supplier.

      Returns:

      The category of the incident.

    • getDescription

      @NonNull LocalizedText 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 the TrafficEngine.

      Returns:

      The human readable description of the incident, possibly with location information.

    • getStartTime

      @Nullable Date getStartTime()

      Gets the time from which the incident is valid, before this time the incident should not be considered.

      The value is null if it hasn't been provided by the traffic incidents supplier.

      Returns:

      The time from which the incident is valid, before this time the incident should not be considered.

    • getEndTime

      @Nullable Date getEndTime()

      Get the time until which the incident is valid, after this time the incident should not be considered.

      The value is null if it hasn't been provided by the traffic incidents supplier.

      Returns:

      The time until which the incident is valid, after this time the incident should not be considered.