com.azalient.api.b.network
Interface IZone

All Superinterfaces:

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

public interface IZone
extends IPlace, IUserData

A Zone 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 IChoiceTest

CHOICE_TEST A test which returns true if the zone can be used for parking (destination) choice

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

ZERO

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

DELETED, KEY_SEP, KEY_SEP_CHAR

Method Summary

ILink[]	arrivalLinks() An array of links inside the zone on which vehicles can end a trip (arrive)
boolean	choiceOverride() Returns true if choice attribute is set for Zone object
boolean	choiceTarget() Returns true if this zone can be a target for parking (destination) choice, either by override or default rules.
ILink[]	departureLinks() An array of links inside the zone on which vehicles can start a trip (depart)
IArea	directArea() Deprecated. use directAreas()
void	directArea(IArea a) Deprecated. use directAreaAdd()
void	directAreaAdd(IArea a) Add a direct connection area
void	directAreaRemove(IArea a) Remove a direct connection area
IArea[]	directAreas() If this zone is directly connected to any areas then return them.
boolean	isNotTransition()
boolean	isParking() Is this a parking zone?
boolean	isTransition()
ILink[]	links() An array of links inside the zone, the combination of arrival and departure link arrays
int	parkingAvailable() The number of spaces in the parking zone
void	parkingAvailable(int p) Change the number of available spaces in the zone
int	parkingCircles() The number of times a vehicle will circle back to a parking zone looking for a space
ICourse[]	parkingCourses()
ITwig	parkingDestination() The destination twig for a zone that is directly connected to an area
IParkingDestination[]	parkingDestinations() Parking destinations reachable from the origin links in this zone
boolean	parkingDropOff() If true, this (parking) zone is a drop-off zone.
boolean	parkingEquivalent(IZone that) Is this zone equivalent to that zone, in terms of parking.
UTime	parkingExpectedWalkTime() The expected time to walk from the first vacant parking bay to the exit
boolean	parkingInstant() If true, this (parking) zone empties the vehicle on entering, then disappears.
ITwig	parkingOrigin() The origin twig for a zone that is directly connected to an area
boolean	parkingPickUp() If true, this (parking) zone is a pick-up zone
Price	parkingPriceBase() base price for parking.
Price	parkingPriceHour() price per hour for parking.
boolean	parkingTaxiRank() Returns true if this parking zone is a taxi rank
boolean	parkingWaitForVehicle() This flag is used if all parking bays are empty when a person arrives at a parking lane.
int	unreleased() The number of vehicles that are waiting to be released, because of congestion in the zone
int	unreleased(ArrayList<ITrip> list) Return a list of vehicles that are waiting to be released, because of congestion in the zone

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.a.IUserData

userData, userData, userDataHashCode

Field Detail

CHOICE_TEST

static final IChoiceTest CHOICE_TEST

A test which returns true if the zone can be used for parking (destination) choice

Method Detail

departureLinks

ILink[] departureLinks()

An array of links inside the zone on which vehicles can start a trip (depart)

This list is rebuilt every time the zone geometry is changed, so it is not a part of the data that is saved for each zone

arrivalLinks

ILink[] arrivalLinks()

An array of links inside the zone on which vehicles can end a trip (arrive)

This list is rebuilt every time the zone geometry is changed, so it is not a part of the data that is saved for each zone

links

ILink[] links()

An array of links inside the zone, the combination of arrival and departure link arrays

This list is rebuilt every time the zone geometry is changed, so it is not a part of the data that is saved for each zone

unreleased

int unreleased()

The number of vehicles that are waiting to be released, because of congestion in the zone

unreleased

int unreleased(ArrayList<ITrip> list)

Return a list of vehicles that are waiting to be released, because of congestion in the zone

isParking

boolean isParking()

Is this a parking zone?

parkingCourses

ICourse[] parkingCourses()

parkingOrigin

ITwig parkingOrigin()

The origin twig for a zone that is directly connected to an area

parkingDestination

ITwig parkingDestination()

The destination twig for a zone that is directly connected to an area

parkingDestinations

IParkingDestination[] parkingDestinations()

Parking destinations reachable from the origin links in this zone

directArea

IArea directArea()

Deprecated. use directAreas()

directArea

void directArea(IArea a)

Deprecated. use directAreaAdd()

directAreas

IArea[] directAreas()

If this zone is directly connected to any areas then return them. If none, return zero-length array

directAreaAdd

void directAreaAdd(IArea a)

Add a direct connection area

directAreaRemove

void directAreaRemove(IArea a)

Remove a direct connection area

parkingPriceBase

Price parkingPriceBase()

base price for parking. Total price = base price + (hours x price per hour)

parkingPriceHour

Price parkingPriceHour()

price per hour for parking. Total price = base price + (hours x price per hour)

parkingCircles

int parkingCircles()

The number of times a vehicle will circle back to a parking zone looking for a space

parkingExpectedWalkTime

UTime parkingExpectedWalkTime()

The expected time to walk from the first vacant parking bay to the exit

parkingWaitForVehicle

boolean parkingWaitForVehicle()

This flag is used if all parking bays are empty when a person arrives at a parking lane. If true, the person must wait for a vehicle to arrive. If false, a vehicle will be generated

parkingInstant

boolean parkingInstant()

If true, this (parking) zone empties the vehicle on entering, then disappears. Similar to drop-off, but no drive-away

parkingDropOff

boolean parkingDropOff()

If true, this (parking) zone is a drop-off zone. After depositing the passenger(s):

• a non-taxi vehicle will return to its origin zone
• a taxi will go to the nearest rank

parkingPickUp

boolean parkingPickUp()

If true, this (parking) zone is a pick-up zone

parkingTaxiRank

boolean parkingTaxiRank()

Returns true if this parking zone is a taxi rank

parkingEquivalent

boolean parkingEquivalent(IZone that)

Is this zone equivalent to that zone, in terms of parking. If true, a parking trip from this to that will not be allowed

parkingAvailable

int parkingAvailable()

The number of spaces in the parking zone

parkingAvailable

void parkingAvailable(int p)

Change the number of available spaces in the zone

isTransition

boolean isTransition()

isNotTransition

boolean isNotTransition()

choiceOverride

boolean choiceOverride()

Returns true if choice attribute is set for Zone object

choiceTarget

boolean choiceTarget()

Returns true if this zone can be a target for parking (destination) choice, either by override or default rules.