Package com.here.sdk.venue.routing

Class IndoorRouteOptions

java.lang.Object

com.here.sdk.venue.routing.IndoorRouteOptions

public final class IndoorRouteOptions
extends Object

All the options to specify how an indoor route should be calculated.

Field Summary

Fields

Modifier and Type	Field	Description
IndoorAvoidanceOptions	indoorAvoidanceOptions	Options to specify restrictions for indoor route calculations.
RouteOptions	routeOptions	Specifies the common route calculation options.
double	speedInMetersPerSecond	Deprecated. Will be removed in v4.28.0.
VenueTransportMode	transportMode	The transport mode for route calculation.
VenueTransportSpecification	venueTransportSpecification	Defines the venue transport specification which contains the vehicle specifications for the transport mode chosen via transportMode.
List<IndoorWaypoint>	viaWaypoints	Specifies the via waypoints that the route should pass through between the origin and destination.

Constructor Summary

Constructors

Constructor	Description
IndoorRouteOptions()	Creates an object and assign default values for route options.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

routeOptions

@NonNull
public RouteOptions routeOptions

Specifies the common route calculation options.

Note: Currently, only RouteOptions.optimizationMode parameter is utilized for indoor route calculation.

transportMode

@NonNull
public VenueTransportMode transportMode

The transport mode for route calculation.

Note: Mode of transport for the resulting indoor route will by default be VenueTransportMode.PEDESTRIAN in the current implementation. This option will affect only indoor route sections.

venueTransportSpecification

@NonNull
public VenueTransportSpecification venueTransportSpecification

Defines the venue transport specification which contains the vehicle specifications for the transport mode chosen via transportMode. Notes:

• By default all vehicle specifications from venueTransportSpecification are set to null.
• The transport mode is determined by transportMode.

indoorAvoidanceOptions

@NonNull
public IndoorAvoidanceOptions indoorAvoidanceOptions

Options to specify restrictions for indoor route calculations. By default no restrictions are applied.

speedInMetersPerSecond

@Deprecated
public double speedInMetersPerSecond

Deprecated.

Will be removed in v4.28.0. Use VenuePedestrianSpecification.walking_speed_in_meters_per_second instead.

Specifies the speed that will be used by the service as the speed for VenueTransportMode in meters per second. It influences the duration of segments along the route. The default speed is 1 meter per second.

viaWaypoints

@NonNull
public List<IndoorWaypoint> viaWaypoints

Specifies the via waypoints that the route should pass through between the origin and destination. Via waypoints are processed in the exact order provided.

Notes:

• Maximum of 5 via waypoints are allowed.
• Via waypoints can be either stop waypoints (with stop_duration) or passthrough waypoints (with pass_through = true).
• Via waypoints with stop_duration or pass_through = false create section in the resulting route.
• Via waypoints with pass_through = true appear in the section's passthrough array.
• The order of via waypoints determines the routing path and must be preserved.

Constructor Details

IndoorRouteOptions

public IndoorRouteOptions()

Creates an object and assign default values for route options.

Method Details

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object