Package com.cercalia.sdk.model.routing

Enum RouteWeight

java.lang.Object

java.lang.Enum<RouteWeight>

com.cercalia.sdk.model.routing.RouteWeight

All Implemented Interfaces:

Serializable, Comparable<RouteWeight>, java.lang.constant.Constable

public enum RouteWeight
extends Enum<RouteWeight>

Weight/optimization criteria for route calculation.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DISTANCE	Optimize for shortest distance.
FAST	Fast route (may be longer in distance).
MONEY	Optimize for lowest toll cost.
REALTIME	Use real-time traffic data.
SHORT	Short route (may be longer in time).
SPMONEY	Scheduled/predictive toll cost (requires departureTime).
SPTIME	Scheduled/predictive time (requires departureTime).
TIME	Optimize for shortest time.
TIMERIMP	Time with traffic impedance.

Method Summary

Modifier and Type	Method	Description
String	getValue()
static RouteWeight	valueOf(String name)	Returns the enum constant of this type with the specified name.
static RouteWeight[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TIME

public static final RouteWeight TIME

Optimize for shortest time.

DISTANCE

public static final RouteWeight DISTANCE

Optimize for shortest distance.

MONEY

public static final RouteWeight MONEY

Optimize for lowest toll cost.

REALTIME

public static final RouteWeight REALTIME

Use real-time traffic data.

FAST

public static final RouteWeight FAST

Fast route (may be longer in distance).

SHORT

public static final RouteWeight SHORT

Short route (may be longer in time).

SPTIME

public static final RouteWeight SPTIME

Scheduled/predictive time (requires departureTime).

SPMONEY

public static final RouteWeight SPMONEY

Scheduled/predictive toll cost (requires departureTime).

TIMERIMP

public static final RouteWeight TIMERIMP

Time with traffic impedance.

Method Details

values

public static RouteWeight[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RouteWeight valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public String getValue()

Returns:

The API value for the weight.