Class IWRouteOptions

This class encapsulates important attributes to configure the routing calculation.

This class is part of the module routing.

TYPE_ECONOMY

String TYPE_ECONOMY

Most economic route.

TYPE_LENGTH

String TYPE_LENGTH

Shortest route.

TYPE_SPEED

String TYPE_SPEED

Fastest route.

IWRouteOptions

IWRouteOptions()

Creates a new router option object.

getCitySpeed

number getCitySpeed()

Returns the average driving speed in cities.

Returns:
number the average driving speed in cities.

getCountryRoadSpeed

number getCountryRoadSpeed()

Returns the average driving speed on country roads. The default value is set to 70

Returns:
number the average driving speed on country roads

getHighwaySpeed

number getHighwaySpeed()

Returns the average driving speed on highways. The default value is set to 120.

Returns:
number the average driving speed on highways

getMaxInterstations

getMaxInterstations()

undocumented

getMobilityProfile

getMobilityProfile()

Gets the mobility profile (e.g. pedestrian, car)

getProfile

getProfile()

Gets the routing profile

getTrafficProfiles

getTrafficProfiles()

Gets the traffic profiles (e.g. traffic flows, traffic events)

getType

String getType()

Returns the current routing type.

Returns:
String the current routing type

getUserDefinedProfiles

getUserDefinedProfiles()

Gets the user defined profiles

isInternationalRoutingAllowed

isInternationalRoutingAllowed()

return {boolean}

isShapeEnabled

isShapeEnabled()

return {boolean}

setCitySpeed

void setCitySpeed(citySpeed)

Sets the average driving speed in cities. The default value is set to 50.

Parameters:
number citySpeed - the average driving speed in cities

Returns:
void 

Throws:
Throws an exception if the speed value is not greater than zero.

setCountryRoadSpeed

void setCountryRoadSpeed(countryRoadSpeed)

Sets the average driving speed on country roads. The default value is set to 70.

Parameters:
number countryRoadSpeed

Returns:
void 

Throws:
Throws an exception if the speed value is not greater than zero.

setHighwaySpeed

void setHighwaySpeed(highwaySpeed)

Sets the average driving speed on highways. The default value is set to 120.

Parameters:
number highwaySpeed - the average driving speed on highways

Returns:
void 

Throws:
Throws an exception if the speed value is not greater than zero.

setInternationalRoutingAllowed

void setInternationalRoutingAllowed(international)

Should routing beyond German borders be allowed

Parameters:
boolean international

Returns:
void 

setMaxInterstations

setMaxInterstations(maxInterstations)

Parameters:
number maxInterstations - number of maximal allowed interstations

setMobilityProfile

setMobilityProfile(profile)

Sets the mobility profile (e.g. pedestrian, car)

Parameters:
profile - the profile name

setProfile

setProfile(profile)

Sets the routing profile

Parameters:
profile

setShapeEnabled

void setShapeEnabled(shapeEnabled)

Parameters:
boolean shapeEnabled

Returns:
void 

setTrafficProfiles

setTrafficProfiles(profiles)

Sets the traffic profiles (e.g. traffic flows, traffic events)

Parameters:
profiles - an array of profile names

setType

void setType(type)

Sets the routing mode to calculate the route. The following modes are supported:
• IWRouteOptions.TYPE_SPEED - fastest route
• IWRouteOptions.TYPE_LENGTH - shortest route
• IWRouteOptions.TYPE_ECONOMY - most economic route

The default value is set to IWRouteOptions.TYPE_SPEED.

Parameters:
String type - the new routing mode

Returns:
void 

setUserDefinedProfiles

setUserDefinedProfiles(profiles)

Sets the user defined profiles

Parameters:
profiles - an array of profile names

toString

String toString()

Returns a string representation for this object.

Returns:
String