com.inrix.sdk.model

Class XDIncident

java.lang.Object

com.inrix.sdk.model.Incident

com.inrix.sdk.model.XDIncident

All Implemented Interfaces:

Parcelable

public class XDIncident
extends Incident
implements Parcelable

A Future Incident / XDIncident class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XDIncident.IncidentDirection An Enum that describes the direction of the XDIncident in terms of cardinal directions.
static class	XDIncident.RecurringSchedule Data structure that describes the RecurringSchedule for a XDIncident.
static class	XDIncident.Status An Enum that describes the status of a XDIncident.
static class	XDIncident.XDLocation Location data for an XDIncident.

Nested classes/interfaces inherited from class com.inrix.sdk.model.Incident

Incident.Community, Incident.Contributor, Incident.DelayImpact, Incident.IncidentSeverity, Incident.IncidentType, Incident.ParameterizedDescription

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static Parcelable.Creator<XDIncident>	CREATOR Parcelable creator for this type.

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
XDIncident(Incident incident) Initializes an instance of XDIncident from Incident.
XDIncident(Parcel in) Create an instance of XDIncident from a Parcel.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
Incident.DelayImpact	getDelayImpact() Gets information on how much the incident will delay travel times.
double	getDistanceKM() Gets the distance value that was previously set.
Date	getEndTime() Gets the time when the incident ends.
Integer	getEventCode() Gets the AlertC event code associated with the type of incident.
String	getFullDescription() Gets a longer textual description of the incident.
GeoPoint	getHead() Gets the location of the farthest point on the road where the incident starts.
long	getId() Gets the INRIX ID for the incident.
List<Integer>	getInrixEventCodes() Gets the list of all INRIX event codes.
List<GeoPoint>	getLastDetourPoints() Gets the locations of the last detour points to use to avoid the incident.
double	getLatitude() Gets the latitude of the incident.
double	getLongitude() Gets the longitude of the incident.
Incident.ParameterizedDescription	getParameterizedDescription() Gets the detailed information about the event specified by the AlertC event code.
XDIncident.RecurringSchedule	getRecurringSchedule() Get the recurrence schedule for a XDIncident.
String	getScheduleDescription() Get the description for the XDIncident.
Incident.IncidentSeverity	getSeverity() Gets the severity of the incident.
String	getShortDescription() Gets a short textual description of the incident.
Date	getStartTime() Gets the time when the incident starts.
XDIncident.Status	getStatus() Get the XDIncident.Status of the current XDIncident.
List<GeoPoint>	getTails() Gets the locations of the points behind the head where the incident ends.
Incident.IncidentType	getType() Gets the incident type.
int	getVersion() Gets the version for the incident.
XDIncident.XDLocation	getXDLocation() Get the extended location details for the XDIncident.
int	hashCode()
boolean	isImpacting() Gets whether the incident is impacting traffic.
String	toString()
void	writeToParcel(Parcel dest, int flags)

Methods inherited from class com.inrix.sdk.model.Incident

describeContents, getBearingAngle, getCommunity, getDescription, getDistance, getLocation, getSource, isUgi, setDistance

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface android.os.Parcelable

describeContents

Field Detail

CREATOR

public static final Parcelable.Creator<XDIncident> CREATOR

Parcelable creator for this type.

Constructor Detail

XDIncident

public XDIncident(Incident incident)

Initializes an instance of XDIncident from Incident.

Parameters:

incident - Instance of Incident.

XDIncident

public XDIncident(Parcel in)

Create an instance of XDIncident from a Parcel.

Parameters:

in - The Parcel.

Method Detail

toString

public String toString()

Overrides:

toString in class Incident

equals

public boolean equals(Object o)

Overrides:

equals in class Incident

hashCode

public int hashCode()

Overrides:

hashCode in class Incident

writeToParcel

public void writeToParcel(Parcel dest,
                 int flags)

Specified by:

writeToParcel in interface Parcelable

getDistanceKM

public final double getDistanceKM()

Gets the distance value that was previously set.

Specified by:

getDistanceKM in class Incident

Returns:

The distance value that was set.

getId

public long getId()

Gets the INRIX ID for the incident.

Specified by:

getId in class Incident

Returns:

The ID.

getVersion

public int getVersion()

Gets the version for the incident. If the incident information is updated, the version number is incremented.

Specified by:

getVersion in class Incident

Returns:

The incident version.

getType

public final Incident.IncidentType getType()

Description copied from class: Incident

Gets the incident type.

Specified by:

getType in class Incident

Returns:

The incident type.

getSeverity

public final Incident.IncidentSeverity getSeverity()

Description copied from class: Incident

Gets the severity of the incident.

Specified by:

getSeverity in class Incident

Returns:

The incident severity.

getStatus

public XDIncident.Status getStatus()

Get the XDIncident.Status of the current XDIncident.

Returns:

the status.

getLatitude

public double getLatitude()

Gets the latitude of the incident.

Specified by:

getLatitude in class Incident

Returns:

The incident's latitude.

getLongitude

public double getLongitude()

Gets the longitude of the incident.

Specified by:

getLongitude in class Incident

Returns:

The incident's longitude.

getFullDescription

public String getFullDescription()

Gets a longer textual description of the incident.

Specified by:

getFullDescription in class Incident

Returns:

The full description.

getShortDescription

public String getShortDescription()

Gets a short textual description of the incident.

Specified by:

getShortDescription in class Incident

Returns:

The short description.

getParameterizedDescription

public Incident.ParameterizedDescription getParameterizedDescription()

Gets the detailed information about the event specified by the AlertC event code.

Specified by:

getParameterizedDescription in class Incident

Returns:

The parameterized description.

getDelayImpact

public Incident.DelayImpact getDelayImpact()

Gets information on how much the incident will delay travel times.

Specified by:

getDelayImpact in class Incident

Returns:

The delay impact.

getHead

public GeoPoint getHead()

Gets the location of the farthest point on the road where the incident starts.

Specified by:

getHead in class Incident

Returns:

The incident start location.

getTails

public List<GeoPoint> getTails()

Gets the locations of the points behind the head where the incident ends.

Specified by:

getTails in class Incident

Returns:

Points where the incident ends.

getLastDetourPoints

public List<GeoPoint> getLastDetourPoints()

Gets the locations of the last detour points to use to avoid the incident.

Specified by:

getLastDetourPoints in class Incident

Returns:

The last detour points.

getStartTime

public Date getStartTime()

Gets the time when the incident starts.

Specified by:

getStartTime in class Incident

Returns:

The incident start time.

getEndTime

public Date getEndTime()

Gets the time when the incident ends.

Specified by:

getEndTime in class Incident

Returns:

The end time.

isImpacting

public boolean isImpacting()

Gets whether the incident is impacting traffic.

Specified by:

isImpacting in class Incident

Returns:

true if the incident is impacting traffic; otherwise, false.

getEventCode

public Integer getEventCode()

Gets the AlertC event code associated with the type of incident.

Specified by:

getEventCode in class Incident

Returns:

The AlertC event code.

getInrixEventCodes

public List<Integer> getInrixEventCodes()

Gets the list of all INRIX event codes.

Returns:

INRIX event codes.

getScheduleDescription

public String getScheduleDescription()

Get the description for the XDIncident.

Returns:

String representation

getRecurringSchedule

public XDIncident.RecurringSchedule getRecurringSchedule()

Get the recurrence schedule for a XDIncident.

Returns:

An instance of XDIncident.RecurringSchedule

getXDLocation

public XDIncident.XDLocation getXDLocation()

Get the extended location details for the XDIncident.

Returns:

An instance of XDIncident.XDLocation.