Package es.situm.sdk.directions

Class DirectionsRequest

java.lang.Object

es.situm.sdk.directions.DirectionsRequest

All Implemented Interfaces:

android.os.Parcelable

public class DirectionsRequest
extends java.lang.Object
implements android.os.Parcelable

Parameters to request a route with DirectionsManager.

Use the DirectionsRequest.Builder to create an instance. Instances are immutable.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DirectionsRequest.AccessibilityMode	The accessibility mode used to calculate a route
static class	DirectionsRequest.Builder	DirectionsRequest builder static inner class.

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

android.os.Parcelable.ClassLoaderCreator<T extends java.lang.Object>, android.os.Parcelable.Creator<T extends java.lang.Object>

Field Summary

Fields

Modifier and Type	Field	Description
static android.os.Parcelable.Creator<DirectionsRequest>	CREATOR
static DirectionsRequest.AccessibilityMode	DEFAULT_ACCESSIBILITY_MODE

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Modifier and Type	Method	Description
boolean	containsValidModifiers()	Check if there are valid modifiers (which action is different that UNKNOWN)
int	describeContents()
boolean	equals(java.lang.Object o)
DirectionsRequest.AccessibilityMode	getAccessibilityMode()	Returns the DirectionsRequest.AccessibilityMode of the route
Angle	getBearingFrom()	Returns the user's bearing in the starting point.
java.util.List<es.situm.sdk.directions.internal.calc.RouteCollider>	getExclusions()	Returns the list of elements used to exclude areas from the route.
Point	getFrom()	Returns the point where the route should start.
DirectionsOptions	getOptions()	Returns object that contains different parameters related to how a route is computed.
Point	getTo()	Returns the point where the route should end.
int	hashCode()
boolean	isAccessible()	Returns whether the route has to be suitable for wheel chairs (true) or not (false)
DirectionsRequest	legacyRequest()
boolean	minimizeFloorChanges()	Returns if the route will be calculated minimizing the floor changes
java.lang.String	toString()
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_ACCESSIBILITY_MODE

public static final DirectionsRequest.AccessibilityMode DEFAULT_ACCESSIBILITY_MODE

CREATOR

public static final android.os.Parcelable.Creator<DirectionsRequest> CREATOR

Method Detail

getFrom

public Point getFrom()

Returns the point where the route should start.

Returns:

Point point inside a building (Point.isIndoor() == true)

getBearingFrom

@Nullable
public Angle getBearingFrom()

Returns the user's bearing in the starting point.

Returns:

Angle

getTo

public Point getTo()

Returns the point where the route should end.

Returns:

Point point inside a building (Point.isIndoor() == true)

getOptions

public DirectionsOptions getOptions()

Returns object that contains different parameters related to how a route is computed.

Returns:

DirectionsOptions

isAccessible

public boolean isAccessible()

Returns whether the route has to be suitable for wheel chairs (true) or not (false)

Returns:

boolean

getAccessibilityMode

public DirectionsRequest.AccessibilityMode getAccessibilityMode()

Returns the DirectionsRequest.AccessibilityMode of the route

Returns:

DirectionsRequest.AccessibilityMode

minimizeFloorChanges

public boolean minimizeFloorChanges()

Returns if the route will be calculated minimizing the floor changes

getExclusions

public java.util.List<es.situm.sdk.directions.internal.calc.RouteCollider> getExclusions()

Returns the list of elements used to exclude areas from the route. For internal use only.

Returns:

List of exclusions.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

containsValidModifiers

public boolean containsValidModifiers()

Check if there are valid modifiers (which action is different that UNKNOWN)

Returns:

boolean value that indicates if options have valid modifiers (true) or not (false)

legacyRequest

public DirectionsRequest legacyRequest()

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable