Package es.situm.sdk.directions

Class DirectionsRequest

java.lang.Object

es.situm.sdk.directions.DirectionsRequest

All Implemented Interfaces:

android.os.Parcelable, MapperInterface

public class DirectionsRequest
extends Object
implements android.os.Parcelable, MapperInterface

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 enum	DirectionsRequest.AccessibilityMode	The accessibility mode used to calculate a route
static final class	DirectionsRequest.Builder	DirectionsRequest builder static inner class.

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

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

Field Summary

Fields

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

Fields inherited from interface es.situm.sdk.model.MapperInterface

ACCESSIBILITY_MODE, ACCURACY, ADDRESS, ALTITUDE, ASSET_TRACKING_OPTIONS_BEACON_FILTERS, ASSET_TRACKING_OPTIONS_ENABLED, ASSET_TRACKING_OPTIONS_ITERATIONS_TO_UPLOAD, ASSET_TRACKING_OPTIONS_SCANNING_INTERVAL, BEACON_FILTER_UUID, BEARING, BEARING_FROM, BEARING_QUALITY, BOUNDS, BOUNDS_ROTATED, BUILDING, BUILDING_IDENTIFIER, BUILDING_NAME, CARTESIAN_BEARING, CARTESIAN_COORDINATE, CENTER, CLOSEST_LOCATION_IN_ROUTE, CODE, CONVERSION, COORDINATE, CREATED_AT, CURRENT_INDICATION, CURRENT_STEP_INDEX, CUSTOM_FIELDS, dateFormat, DEGREES, DEGREES_CLOCKWISE, DEVICE_ID, DIAGNOSTICS_OPTIONS_UPLOAD_DIAGNOSTICS_DATA, DIMENSIONS, DISTANCE, DISTANCE_TO_CHANGE_FLOOR_THRESHOLD, DISTANCE_TO_CHANGE_INDICATION_THRESHOLD, DISTANCE_TO_CLOSEST_POINT_IN_ROUTE, DISTANCE_TO_END_STEP, DISTANCE_TO_GOAL, DISTANCE_TO_GOAL_THRESHOLD, DISTANCE_TO_IGNORE_FIRST_INDICATION, DISTANCE_TO_NEXT_LEVEL, DURATION_MINUTES, EDGES, EVENTS, EXCLUDED_TAGS, EXTERNAL_NAVIGATION_PAYLOAD, EXTERNAL_NAVIGATION_TYPE, FIRST_STEP, FLOOR, FLOOR_IDENTIFIER, FLOORS, FOREGROUND_SERVICE_NOTIFICATION_MESSAGE, FOREGROUND_SERVICE_NOTIFICATION_SHOW_STOP_ACTION, FOREGROUND_SERVICE_NOTIFICATION_STOP_ACTION_TEXT, FOREGROUND_SERVICE_NOTIFICATION_TAP_ACTION, FOREGROUND_SERVICE_NOTIFICATION_TITLE, FROM, GEOFENCES, HAS_BEARING, HAS_CARTESIAN_BEARING, HEIGHT, HUMAN_READABLE_MESSAGE, ID, IDENTIFIER, IGNORE_LOW_QUALITY_LOCATIONS, INCLUDED_TAGS, INDICATION_TYPE, INDICATIONS, INDICATIONS_INTERVAL, INDOOR_POIS, INFO_HTML, IS_FIRST, IS_INDOOR, IS_LAST, IS_OUTDOOR, IS_PUBLIC, LAST_STEP, LATITUDE, LONGITUDE, MAP_URL, MINIMIZE_FLOOR_CHANGES, NAME, NEEDED_LEVEL_CHANGE, NEXT_INDICATION, NEXT_LEVEL, NODES, NORTH_EAST, NORTH_WEST, ORIENTATION, ORIENTATION_TYPE, OUTDOOR_BUILDING_DETECTOR_BLE, OUTDOOR_POIS, OUTSIDE_ROUTE_THRESHOLD, PICTURE_THUMB_URL, PICTURE_URL, POI_CATEGORIES, POI_CATEGORY, POI_CATEGORY_CODE, POI_CATEGORY_ICON_SELECTED, POI_CATEGORY_ICON_UNSELECTED, POI_CATEGORY_IDENTIFIER, POI_CATEGORY_IDENTIFIERS, POI_CATEGORY_iNAME, POI_CATEGORY_NAME, POI_NAME, POI_TO, POI_TO_IDENTIFIER, POINTS, POLYGON_POINTS, POSITION, PROVIDER, QUALITY, RADIANS, RADIANS_MINUS_PI_PI, RADIUS, REALTIME_UPDATE_INTERVAL, ROTATION, ROUND_INDICATIONS_STEP, ROUTE, ROUTE_STEP, SCALE, SEGMENTS, SOUTH_EAST, SOUTH_WEST, STATUS_NAME, STATUS_ORDINAL, STEP_IDX_DESTINATION, STEP_IDX_ORIGIN, STEPS, TIME_TO_END_STEP, TIME_TO_FIRST_INDICATION, TIME_TO_GOAL, TIME_TO_IGNORE_UNEXPECTED_FLOOR_CHANGES, TIMESTAMP, TO, TO_LEGACY, TRIGGER, UPDATED_AT, USER_IDENTIFIER, WIDTH, X, Y

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Modifier and Type	Method	Description
int	describeContents()
boolean	equals(Object o)
static DirectionsRequest	fromMap(Map<String,Object> map)	Return a new DirectionsRequest instance object containing the data at the given map.
DirectionsRequest.AccessibilityMode	getAccessibilityMode()	Returns the DirectionsRequest.AccessibilityMode of the route
Angle	getBearingFrom()	Returns the user's bearing in the starting point.
List<String>	getExcludedTags()
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.
List<String>	getIncludedTags()
DirectionsOptions	getOptions()	Returns object that contains different parameters related to how a route is computed.
String	getPoiToIdentifier()	Returns the identifier of the POI where the route should end.
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)
boolean	minimizeFloorChanges()	Returns if the route will be calculated minimizing the floor changes
Map<String,Object>	toMap()	Method to transform object into Map<String, Object>
String	toString()
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_ACCESSIBILITY_MODE

public static final DirectionsRequest.AccessibilityMode DEFAULT_ACCESSIBILITY_MODE

CREATOR

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

Method Details

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)

getPoiToIdentifier

public String getPoiToIdentifier()

Returns the identifier of the POI where the route should end.

Returns:

String Identifier of the POI

getOptions

public DirectionsOptions getOptions()

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

Returns:

DirectionsOptions

getExcludedTags

public List<String> getExcludedTags()

getIncludedTags

public List<String> getIncludedTags()

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 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(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

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

toMap

public Map<String,Object> toMap()

Description copied from interface: MapperInterface

Method to transform object into Map<String, Object>

Specified by:

toMap in interface MapperInterface

Returns:

Map<String, Object> with the information of the object mapped

fromMap

public static DirectionsRequest fromMap(Map<String,Object> map)
                                 throws IllegalArgumentException

Return a new DirectionsRequest instance object containing the data at the given map. Use MapperInterface to populate the Map. The expected fields are those defined at DirectionsRequest.Builder. The DirectionsOptions will be ignored.

Parameters:

map - Map containing the data used to populate the new object.

Returns:

New instance.

Throws:

IllegalArgumentException - If there is not enough information at the given map or it is incorrect.