com.inrix.sdk.model

Class LearnedTrip

java.lang.Object

com.inrix.sdk.model.Trip

com.inrix.sdk.model.LearnedTrip

All Implemented Interfaces:

Parcelable

public class LearnedTrip
extends Trip
implements Parcelable

A LearnedTrip is a Trip learned from the user's driving behavior. LearnedTrips can not be modified, however LearnedTrip may improve over time as additional observation of the user's driving behavior is gathered. The LearnedTrip can be converted/added to a SavedTrip to customize notifications and schedule for the preferred route.

Nested Class Summary

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<LearnedTrip>	CREATOR Parcelable creator for this type.

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Methods

Modifier and Type	Method and Description
int	describeContents()
boolean	equals(Object o)
Date	getDateTime() The predicted arrival date/time of this LearnedTrip instance (UTC).
LearnedLocation	getDestination() Get the destination of the LearnedTrip.
LearnedLocation	getOrigin() Get the origin of the LearnedTrip.
Route	getRoute() Get the Route associated with the LearnedTrip.
double	getWeight() Get the relative weight of this LearnedTrip.
int	hashCode()
boolean	isHidden() Gets the current visibility of the LearnedTrip.
SavedTrip	toSavedTrip() Convert this LearnedTrip into a SavedTrip, using the origin, destination and arrival time of the LearnedTrip.
String	toString()
void	writeToParcel(Parcel dest, int flags)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

CREATOR

public static final Parcelable.Creator<LearnedTrip> CREATOR

Parcelable creator for this type.

Method Detail

writeToParcel

public void writeToParcel(Parcel dest,
                 int flags)

Specified by:

writeToParcel in interface Parcelable

describeContents

public int describeContents()

Specified by:

describeContents in interface Parcelable

getDateTime

public Date getDateTime()

The predicted arrival date/time of this LearnedTrip instance (UTC).

Returns:

arrival date/time

getOrigin

public LearnedLocation getOrigin()

Get the origin of the LearnedTrip.

Returns:

origin of the LearnedTrip

getDestination

public LearnedLocation getDestination()

Get the destination of the LearnedTrip.

Returns:

destination of the LearnedTrip

getWeight

public double getWeight()

Get the relative weight of this LearnedTrip. Higher values indicate higher likelihood of taking this LearnedTrip over other LearnedTrips at the same time.

Returns:

weight of the LearnedTrip

getRoute

public Route getRoute()

Get the Route associated with the LearnedTrip. The returned Route will not contain any details until it is updated using RouteManager.getUpdatedRouteInfo(RouteManager.UpdatedRouteOptions, RouteManager.IUpdatedRouteListener).

Based on the user's driving pattern the same Trip may result in multiple LearnedTrips if for example the user takes different routes on different days.

Returns:

Route associated with the trip or null if not available

isHidden

public boolean isHidden()

Gets the current visibility of the LearnedTrip. All LearnedTrips are visible unless they are explicitly hidden.

Returns:

true if the trip is hidden, false otherwise.

toSavedTrip

public SavedTrip toSavedTrip()

Convert this LearnedTrip into a SavedTrip, using the origin, destination and arrival time of the LearnedTrip.

Returns:

an instance of SavedTrip

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public final String toString()

Overrides:

toString in class Object