com.pb.routing.enums

Enum HistoricSpeedBucket

java.lang.Object

java.lang.Enum<HistoricSpeedBucket>

com.pb.routing.enums.HistoricSpeedBucket

All Implemented Interfaces:

Serializable, Comparable<HistoricSpeedBucket>

public enum HistoricSpeedBucket
extends Enum<HistoricSpeedBucket>

Supported historic traffic time buckets available for routing operations. These speeds are based on different time-of-day buckets. The data must have historic traffic speeds included in order to use this feature.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AM_PEAK Calculates route with the peak AM speeds.
NIGHT_SPEED Calculates route with the night time speeds.
NONE Default value for HistoricSpeedBucket.
OFF_PEAK Calculates route with the off peak (daytime) speeds.
PM_PEAK Calculates route with the peak PM speeds.

Method Summary

Modifier and Type	Method and Description
String	getValue() Returns the value of the HistoricSpeedBucket.
static HistoricSpeedBucket	toHistoricTrafficTimeBucket(String input) Converts the specified value to corresponding HistoricSpeedBucket choice.
static HistoricSpeedBucket	valueOf(String name) Returns the enum constant of this type with the specified name.
static HistoricSpeedBucket[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final HistoricSpeedBucket NONE

Default value for HistoricSpeedBucket. Historic traffic data is not used in the calculation, instead an averaged speed value is used.

AM_PEAK

public static final HistoricSpeedBucket AM_PEAK

Calculates route with the peak AM speeds. The AMPeak time bucket is from 07:00 to 10:00hr time of day.

PM_PEAK

public static final HistoricSpeedBucket PM_PEAK

Calculates route with the peak PM speeds. The PMPeak time bucket is from 16:00 to 19:00hr time of day.

OFF_PEAK

public static final HistoricSpeedBucket OFF_PEAK

Calculates route with the off peak (daytime) speeds. The OffPeak time bucket is from 10:00 to 16:00hr time of day.

NIGHT_SPEED

public static final HistoricSpeedBucket NIGHT_SPEED

Calculates route with the night time speeds. The Night time bucket is from 22:00 to 04:00hr time of day.

Method Detail

values

public static HistoricSpeedBucket[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (HistoricSpeedBucket c : HistoricSpeedBucket.values())
    System.out.println(c);

Returns:

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

valueOf

public static HistoricSpeedBucket 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 value of the HistoricSpeedBucket.

Returns:

A String, the value of the HistoricSpeedBucket.

toHistoricTrafficTimeBucket

public static HistoricSpeedBucket toHistoricTrafficTimeBucket(String input)

Converts the specified value to corresponding HistoricSpeedBucket choice.

For e.g. HistoricSpeedBucket.toHistoricTrafficTimeBucket("ampeak") gives HistoricSpeedBucket.AM_PEAK

Parameters:

input - A String, historic speed bucket value.

Returns:

Corresponding HistoricSpeedBucket choice.