com.inrix.sdk.model

Class TripPoint

java.lang.Object

com.inrix.sdk.model.TripPoint

All Implemented Interfaces:

Parcelable, Cloneable

public class TripPoint
extends Object
implements Parcelable, Cloneable

Represents any location associated with a Trip, including the origin, destination, or any intermediate way-points on the Trip.

There are two ways to reference a location when creating a TripPoint:

• Using a Location from the user's saved locations
• Using a GeoPoint with latitude/longitude coordinates

Additional details (beyond the coordinates and the name) about the TripPoint can be retrieved using the LocationsManager if the TripPoint references a Location.

NOTE: Any name specified during creation will not be modified based on current language or locale settings. Calling TripPoint.getName() always returns the value which was provided when creating the TripPoint instance.

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<TripPoint>	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
TripPoint(Location location) Create a TripPoint with the specified Location.
TripPoint(String displayName, GeoPoint coordinates) Create a TripPoint with the specified name, and coordinates.
TripPoint(String displayName, GeoPoint coordinates, int durationMinutes) Create a TripPoint with the specified name, coordinates, and duration.
TripPoint(T location, int durationMinutes) Create a TripPoint with the specified Location, and duration.

Method Summary

Methods

Modifier and Type	Method and Description
int	describeContents()
boolean	equals(Object o)
int	getDuration() Get the duration (in minutes) the user will stop at this location.
Location	getLocation() Get the Location associated with this TripPoint.
String	getName() Get the name of this location.
GeoPoint	getPoint() Get the latitude/longitude coordinate of this location as a GeoPoint.
TimeZone	getTimeZone() Returns the TimeZone for this TripPoint.
int	hashCode()
boolean	isDeleted() Returns true if the Location used to create this TripPoint has been deleted.
void	setDuration(int duration) Set the duration (in minutes) the user will stop at this location.
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<TripPoint> CREATOR

Parcelable creator for this type.

Constructor Detail

TripPoint

public TripPoint(String displayName,
         GeoPoint coordinates,
         int durationMinutes)

Create a TripPoint with the specified name, coordinates, and duration.

Parameters:

displayName - display name of the location, may be null

coordinates - latitude/longitude coordinates of the location, must not be null

durationMinutes - duration (in minutes) the user will stop at this location

See Also:

GeoPoint

TripPoint

public TripPoint(String displayName,
         GeoPoint coordinates)

Create a TripPoint with the specified name, and coordinates.

Parameters:

displayName - display name of the location, may be null

coordinates - latitude/longitude coordinates of the location, must not be null

See Also:

GeoPoint

TripPoint

public TripPoint(T location,
         int durationMinutes)

Create a TripPoint with the specified Location, and duration.

Type Parameters:

T - the type of location

Parameters:

location - location, must not be null

durationMinutes - duration (in minutes) the user will stop at this location

See Also:

Location

TripPoint

public TripPoint(Location location)

Create a TripPoint with the specified Location.

Parameters:

location - location, must not be null

See Also:

Location

Method Detail

describeContents

public final int describeContents()

Specified by:

describeContents in interface Parcelable

writeToParcel

public final void writeToParcel(Parcel dest,
                 int flags)

Specified by:

writeToParcel in interface Parcelable

getLocation

public Location getLocation()

Get the Location associated with this TripPoint. The return value may be null if there is no associated Location or if the associated Location is no longer available.

Returns:

Location if available, null otherwise

getPoint

public GeoPoint getPoint()

Get the latitude/longitude coordinate of this location as a GeoPoint.

Returns:

coordinates of the location

See Also:

GeoPoint

getName

public String getName()

Get the name of this location.

If there was no name provided when the TripPoint was created then this method will return null. In this case the GeoPoint should be converted into a user-friendly location to obtain a user-friendly location using a reverse geocode.

Returns:

name of the location

getDuration

public int getDuration()

Get the duration (in minutes) the user will stop at this location. This value is only relevant if the TripPoint is one of the way-points on a Trip and will be ignored if the TripPoint is the origin or destination.

Returns:

duration (in minutes)

setDuration

public void setDuration(int duration)

Set the duration (in minutes) the user will stop at this location. This value is only relevant if the TripPoint is one of the way-points on a Trip and will be ignored if the TripPoint is the origin or destination.

The duration must also be a non-negative value, and negative values are ignored and the duration defaults to 0.

Parameters:

duration - duration (in minutes)

isDeleted

public boolean isDeleted()

Returns true if the Location used to create this TripPoint has been deleted.

If true, this implies that the TripPoint.getLocationId() is no longer valid.

Returns:

true if the associated Location has been deleted, false otherwise or if the TripPoint was not created from a Location

getTimeZone

public TimeZone getTimeZone()

Returns the TimeZone for this TripPoint. The time zone can be used to calculate a meaningful arrival/departure time for a Trip given travel time.

The timezone is only available after the Trip has been saved.

Returns:

time zone at this TripPoint, or null if the time zone is not available

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

toString

public final String toString()

Overrides:

toString in class Object