com.azalient.api.b.parking
Interface IParkingVehicle

public interface IParkingVehicle

This object holds the extra data required by a vehicle when it parks

Method Summary

double	arriveCount() Returns the countdown value, in seconds, when the vehicle is arriving
void	arriveCount(double c) [Internal use only]
void	atBay(boolean atBay, boolean facingForward) [Internal use only]
ILane	bayLane() If the vehicle has decided the lane in which it will park, this returns a reference to that lane
ILink	bayLink() If the vehicle has decided the lane in which it will park, this returns a reference to the link for that lane
void	choose(ILane lane, int laneBay, int zoneBay) [Internal use only]
boolean	chosen() Returns true if the vehicle has chosen a bay
int	chosenLaneBay() Returns the lane-index of the chosen bay (not the same as the zone-index)
int	chosenZoneBay() Returns the zone-index of the chosen bay (not the same as the lane-index)
void	departAndUnpark() [Internal use only]
double	departCount() Returns the countdown value, in seconds, when the vehicle is departing
void	departCount(double c) [Internal use only]
double	dwellTime() Returns the recorded dwell time, in seconds, increased on every time step
void	dwellTime(double t) [Internal use only]
boolean	enteringForward() Returns true if this vehicle will park face-in
boolean	frozen() Returns true if this vehicle is parked, or not quite ready to leave
boolean	isAtBay() Returns true if the vehicle has arrived at the chosen parking bay
int	lanePopularity() Returns the current lane popularity during parking search
void	lanePopularity(int lanePopularity, ILink[] targetLinks) [Internal use only]
boolean	leaving() Returns true if the vehicle is leaving the bay
int	leavingZoneBay() Returns a positive value when the vehicle is leaving the parking lane
void	leavingZoneBay(int b) [Internal use only]
IZone	nearestTaxiRank(IVehicle v, ILink link, IZone current) Find the nearest taxi rank zone, excluding the given zone, which can be null
IOccupant	occupant() Returns a reference to the occupant of this vehicle.
void	park() [Internal use only]
boolean	parked() Returns true if the vehicle has arrived and completed the parking manoeuvre
IParkingLane	parkingLane() If the vehicle has decided the lane in which it will park, this returns a reference to the parkingLane object for that lane
boolean	readyToLeave(IPerson person) Returns true when a vehicle is available to be used by a person walking towards the parking lane.
void	resetChoice() [Internal use only]
ILink[]	targetLinks() [Internal use only]
void	unpark() [Internal use only]
Boolean	uTurnOnDeparture() Returns true if this vehicle will make a u-turn on departure, false if it will not, or null if this has not yet been decided
void	uTurnOnDeparture(Boolean b) [Internal use only]
IVehicle	vehicle() Returns a reference to the vehicle
void	whileParked() [Internal use only]

Method Detail

vehicle

IVehicle vehicle()

Returns a reference to the vehicle

occupant

IOccupant occupant()

Returns a reference to the occupant of this vehicle. The occupant may be null, for example for a vehicle generated at time = 0, or for a vehicle arriving from an origin zone that is not linked to an area

parkingLane

IParkingLane parkingLane()

If the vehicle has decided the lane in which it will park, this returns a reference to the parkingLane object for that lane

bayLink

ILink bayLink()

If the vehicle has decided the lane in which it will park, this returns a reference to the link for that lane

bayLane

ILane bayLane()

If the vehicle has decided the lane in which it will park, this returns a reference to that lane

isAtBay

boolean isAtBay()

Returns true if the vehicle has arrived at the chosen parking bay

chosen

boolean chosen()

Returns true if the vehicle has chosen a bay

parked

boolean parked()

Returns true if the vehicle has arrived and completed the parking manoeuvre

leaving

boolean leaving()

Returns true if the vehicle is leaving the bay

readyToLeave

boolean readyToLeave(IPerson person)

Returns true when a vehicle is available to be used by a person walking towards the parking lane. This happens when the previous occupant arrives at the destination area

enteringForward

boolean enteringForward()

Returns true if this vehicle will park face-in

chosenLaneBay

int chosenLaneBay()

Returns the lane-index of the chosen bay (not the same as the zone-index)

chosenZoneBay

int chosenZoneBay()

Returns the zone-index of the chosen bay (not the same as the lane-index)

leavingZoneBay

int leavingZoneBay()

Returns a positive value when the vehicle is leaving the parking lane

dwellTime

double dwellTime()

Returns the recorded dwell time, in seconds, increased on every time step

arriveCount

double arriveCount()

Returns the countdown value, in seconds, when the vehicle is arriving

departCount

double departCount()

Returns the countdown value, in seconds, when the vehicle is departing

lanePopularity

int lanePopularity()

Returns the current lane popularity during parking search

lanePopularity

void lanePopularity(int lanePopularity,
                    ILink[] targetLinks)

[Internal use only]

Internal - Not recommended for use. Public as a side-effect of implementation method

choose

void choose(ILane lane,
            int laneBay,
            int zoneBay)

[Internal use only]

Internal - Not recommended for use. Public as a side-effect of implementation method

atBay

void atBay(boolean atBay,
           boolean facingForward)

[Internal use only]

Internal - Not recommended for use. Public as a side-effect of implementation method

park

void park()

[Internal use only]

Internal - Not recommended for use. Public as a side-effect of implementation method

unpark

void unpark()

[Internal use only]

Internal - Not recommended for use. Public as a side-effect of implementation method

whileParked

void whileParked()

[Internal use only]

Internal - Not recommended for use. Public as a side-effect of implementation method

resetChoice

void resetChoice()

[Internal use only]

Internal - Not recommended for use. Public as a side-effect of implementation method

arriveCount

void arriveCount(double c)

[Internal use only]

Internal - Not recommended for use. Public as a side-effect of implementation method

departCount

void departCount(double c)

[Internal use only]

Internal - Not recommended for use. Public as a side-effect of implementation method

dwellTime

void dwellTime(double t)

[Internal use only]

Internal - Not recommended for use. Public as a side-effect of implementation method

departAndUnpark

void departAndUnpark()

[Internal use only]

Internal - Not recommended for use. Public as a side-effect of implementation method

leavingZoneBay

void leavingZoneBay(int b)

[Internal use only]

Internal - Not recommended for use. Public as a side-effect of implementation method

targetLinks

ILink[] targetLinks()

[Internal use only]

Internal - Not recommended for use. Public as a side-effect of implementation method

nearestTaxiRank

IZone nearestTaxiRank(IVehicle v,
                      ILink link,
                      IZone current)

Find the nearest taxi rank zone, excluding the given zone, which can be null

frozen

boolean frozen()

Returns true if this vehicle is parked, or not quite ready to leave

uTurnOnDeparture

void uTurnOnDeparture(Boolean b)

[Internal use only]

Internal - Not recommended for use. Public as a side-effect of implementation method

uTurnOnDeparture

Boolean uTurnOnDeparture()

Returns true if this vehicle will make a u-turn on departure, false if it will not, or null if this has not yet been decided