Class TrafficIncidentOnRoute

TrafficIncidentOnRoute (API Reference)

java.lang.Object
- com.here.NativeBase
- - com.here.sdk.routing.TrafficIncidentOnRoute

All Implemented Interfaces:

TrafficIncidentBase
```
public final class TrafficIncidentOnRoute
extends NativeBase
implements TrafficIncidentBase
```
Traffic incidents on a route. Use Section.getTrafficIncidents() to get a list of incidents on a route section. Use Span.getTrafficIncidentIndexes() to associate incidents with spans. Each incident takes at least the whole geometry of matching spans. Also, an incident can take some place out of the built route.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`LocalizedText`	`getDescription()`	Gets the human readable description of the incident, possibly with location information.
`java.util.Date`	`getEndTime()`	Get the time until which the incident is valid, after this time the incident should not be considered.
`java.lang.String`	`getId()`	Gets the unique current identifier for a traffic incident.
`TrafficIncidentImpact`	`getImpact()`	Gets the impact of the incident.
`java.util.Date`	`getStartTime()`	Gets the time from which the incident is valid, before this time the incident should not be considered.
`TrafficIncidentType`	`getType()`	Gets the category of the incident.

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

- Method Detail
  - getId
```
@Nullable
public java.lang.String getId()
```
    Gets the unique current identifier for a traffic incident.
    The identifier can be changed by the backend due to some events, e.g. changing of TrafficIncidentBase.getEndTime(). This field will be empty for OfflineRouting.
    
    Returns:
    
    The unique current identifier for a traffic incident.
  - getImpact
```
@NonNull
public TrafficIncidentImpact getImpact()
```
    Gets the impact of the incident.
    The value is TrafficIncidentImpact.UNKNOWN if it hasn't been provided by the traffic incidents supplier.
    
    Specified by:
    
    getImpact in interface TrafficIncidentBase
    
    Returns:
    
    The impact of the incident.
  - getType
```
@NonNull
public TrafficIncidentType getType()
```
    Gets the category of the incident.
    The value is TrafficIncidentType.UNKNOWN if it hasn't been provided by the traffic incidents supplier.
    
    Specified by:
    
    getType in interface TrafficIncidentBase
    
    Returns:
    
    The category of the incident.
  - getDescription
```
@NonNull
public 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.
    
    Specified by:
    
    getDescription in interface TrafficIncidentBase
    
    Returns:
    
    The human readable description of the incident, possibly with location information.
  - getStartTime
```
@Nullable
public java.util.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.
    
    Specified by:
    
    getStartTime in interface TrafficIncidentBase
    
    Returns:
    
    The time from which the incident is valid, before this time the incident should not be considered.
  - getEndTime
```
@Nullable
public java.util.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.
    
    Specified by:
    
    getEndTime in interface TrafficIncidentBase
    
    Returns:
    
    The time until which the incident is valid, after this time the incident should not be considered.

Class TrafficIncidentOnRoute

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getId

getImpact

getType

getDescription

getStartTime

getEndTime