com.azalient.api.b.network
Interface IArea

All Superinterfaces:

IDecisionOption, IDescribed, IPlace, IPlaces, IRecord, RecordR, RecordRW, RecordW, SortableData, StoreRecordRW

public interface IArea
extends IPlace, IDecisionOption

An area is a space in the network that can be used as an origin or a destination for vehicle trips. The shape of a zone is defined by a polygonal prism, that is a boundary of points, defining the base, and a single uniform height value

Field Summary

static IArea[]

ZERO A static zero-length array, created for convenience, and to save memory

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

DELETED, KEY_SEP, KEY_SEP_CHAR

Method Summary

ITwig	directArrivalAreaStandTwig() For an area connected directly to an arrival stand, this returns the routing branch that starts at the stand and ends at the area
ITwig	directArrivalAreaZoneTwig() For an area connected directly to a zone, this returns the routing branch that starts at the zone and ends in the area
IStand	directArrivalStand() Returns a non-null value if this area is directly connected to a stand for arrivals, that is, for trips ending here
ITwig	directDepartureAreaStandTwig() For an area connected directly to a departure stand, this returns the routing branch that starts at the area and ends at the stand
ITwig	directDepartureAreaZoneTwig() For an area connected directly to a zone, this returns the routing branch that starts at the area and ends in the zone
IStand	directDepartureStand() Returns a non-null value if this area is directly connected to a stand for departures, that is, for trips starting here
IZone	directZone() Returns a non-null value if this area is directly connected to a zone
Distance	offNetworkDistance(ITrip t) Return an off-network distance from this area.
Price	offNetworkPrice() Return a (fixed) off-network additional price for this area - for example a bridge toll
UTime	offNetworkTime(ITrip t) Return an off-network time from this area.

Methods inherited from interface com.azalient.api.b.demand.IPlace

arrivalTwigs, centroid, constantVolume, departureTwigs, height, index, intersectsByHeight, isCordon, label, name, nameInt, placeType, points, polygon, selected, vertices

Methods inherited from interface com.azalient.api.b.assignment.IPlaces

contains

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

description

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.file.RecordW

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

Methods inherited from interface com.azalient.api.b.assignment.IDecisionOption

openFrom

Field Detail

ZERO

static final IArea[] ZERO

A static zero-length array, created for convenience, and to save memory

Method Detail

directZone

IZone directZone()

Returns a non-null value if this area is directly connected to a zone

directDepartureStand

IStand directDepartureStand()

Returns a non-null value if this area is directly connected to a stand for departures, that is, for trips starting here

directArrivalStand

IStand directArrivalStand()

Returns a non-null value if this area is directly connected to a stand for arrivals, that is, for trips ending here

offNetworkDistance

Distance offNetworkDistance(ITrip t)

Return an off-network distance from this area. If trip is null, return the mean value, otherwise return a value from a distribution using the mean and standard deviation values specified for the area

offNetworkTime

UTime offNetworkTime(ITrip t)

Return an off-network time from this area. If trip is null, return the mean value, otherwise return a value from a distribution using the mean and standard deviation values specified for the area

offNetworkPrice

Price offNetworkPrice()

Return a (fixed) off-network additional price for this area - for example a bridge toll

directDepartureAreaZoneTwig

ITwig directDepartureAreaZoneTwig()

For an area connected directly to a zone, this returns the routing branch that starts at the area and ends in the zone

directArrivalAreaZoneTwig

ITwig directArrivalAreaZoneTwig()

For an area connected directly to a zone, this returns the routing branch that starts at the zone and ends in the area

directDepartureAreaStandTwig

ITwig directDepartureAreaStandTwig()

For an area connected directly to a departure stand, this returns the routing branch that starts at the area and ends at the stand

directArrivalAreaStandTwig

ITwig directArrivalAreaStandTwig()

For an area connected directly to an arrival stand, this returns the routing branch that starts at the stand and ends at the area