com.azalient.api.b.assignment
Interface IRouteClass

All Superinterfaces:

IActionable, IAssociate, IDescribed, IDraggable, IPastable, IRecord, RecordR, RecordRW, RecordW, SortableData, StoreRecordRW

public interface IRouteClass
extends StoreRecordRW, IPastable, IDescribed

A route class encodes parameters for weighting route costs. It is appropriate for modelling different classes of roads or walkways, in order to bias any routing towards major routes.

Field Summary

static Speed	STD_SPEED_P The standard travel speed (for pedestrians) on walkways
static Speed	STD_SPEED_T The standard travel speed (for trains) on railways
static Speed	STD_SPEED_V The standard travel speed (for vehicles) on roads

Fields inherited from interface com.azalient.api.ui.clipboard.IAssociate

scratch, ZERO

Fields inherited from interface com.azalient.api.a.tables.IRecord

DELETED, KEY_SEP, KEY_SEP_CHAR

Method Summary

NamedColour	color() A colour assigned to this route class, for display purposes
IMotorCalibration.FollowingModel	followingModel() The following model for this class of route.
Price	pricePerLongDistanceUnit() The (monetary) price of travelling one long-distance unit on this class of route.
double	routeDistanceFactor(IBehaviour behaviour) A multiplicative scaling factor, default value 1.0, for route distances on this class of route.
double	routePriceFactor(IBehaviour behaviour) A multiplicative scaling factor, default value 1.0, for route prices on this class of route.
double	routeTimeFactor(IBehaviour behaviour) A multiplicative scaling factor, default value 1.0, for route times on this class of route.
Speed	speed() The speed of travel on this route class
SurfaceMode	surfaceMode() The surface mode - footpath, road or railway

Methods inherited from interface com.azalient.api.ui.clipboard.IPastable

finish, pickables

Methods inherited from interface com.azalient.api.ui.clipboard.IAssociate

clip, name, proxy, selected

Methods inherited from interface com.azalient.api.ui.clipboard.IDraggable

selected, selectedForDraggingDraw

Methods inherited from interface com.azalient.api.ui.clipboard.IActionable

action

Methods inherited from interface com.azalient.api.file.StoreRecordRW

canRename, rename, store

Methods inherited from interface com.azalient.api.file.RecordR

extraSet, finished, isApplicable, isEditable, set

Methods inherited from interface com.azalient.api.a.tables.IRecord

name

Methods inherited from interface com.azalient.api.file.RecordW

extraCols, extraGet, extraGetB, extraGetD, extraGetI, extraGetS, extraGetT, get, isVolatile

Methods inherited from interface com.azalient.api.a.tables.IDescribed

description

Field Detail

STD_SPEED_P

static final Speed STD_SPEED_P

The standard travel speed (for pedestrians) on walkways

STD_SPEED_V

static final Speed STD_SPEED_V

The standard travel speed (for vehicles) on roads

STD_SPEED_T

static final Speed STD_SPEED_T

The standard travel speed (for trains) on railways

Method Detail

color

NamedColour color()

A colour assigned to this route class, for display purposes

speed

Speed speed()

The speed of travel on this route class

surfaceMode

SurfaceMode surfaceMode()

The surface mode - footpath, road or railway

pricePerLongDistanceUnit

Price pricePerLongDistanceUnit()

The (monetary) price of travelling one long-distance unit on this class of route. For example 10c per KM

routeDistanceFactor

double routeDistanceFactor(IBehaviour behaviour)

A multiplicative scaling factor, default value 1.0, for route distances on this class of route. This can be used to make routes of this type "appear" longer or shorter than their true length. For example, minor roads could be made to look longer than they really are, as a way of encoding the driver's uncertainty about travelling on them.

Parameters:

behaviour - The behaviour to which this scale factor applies, which can be null. If no behaviour is specified the factor will be taken from the default "all-behaviours" specification.

routeTimeFactor

double routeTimeFactor(IBehaviour behaviour)

A multiplicative scaling factor, default value 1.0, for route times on this class of route. This can be used to make routes of this type "appear" faster or slower than they really are by changing the apparent travel time. For example, minor roads could be made to look slower than they really are by applying a time factor of more than 1.0 , as a way of encoding the driver's uncertainty about travelling on them.

Parameters:

behaviour - The behaviour to which this scale factor applies, which can be null. If no behaviour is specified the factor will be taken from the default "all-behaviours" specification.

routePriceFactor

double routePriceFactor(IBehaviour behaviour)

A multiplicative scaling factor, default value 1.0, for route prices on this class of route. This can be used to make routes of this type "appear" dearer or cheaper than they really are by changing the apparent travel price.

Parameters:

behaviour - The behaviour to which this scale factor applies, which can be null. If no behaviour is specified the factor will be taken from the default "all-behaviours" specification.

followingModel

IMotorCalibration.FollowingModel followingModel()

The following model for this class of route. It is possible to have a different following model on each class of route, for example Fritzsche on freeways and Gipps on city streets.