com.azalient.api.sim.agents
Interface ITransport

All Superinterfaces:

IAgent, IBlocker, IChangingDrawable, IDrawable, ILoopOccupier, IMotor, IObstacle, IRecord, IRouteFinder, IUserData, RecordR, RecordRW, RecordW, SortableData, StoreRecordRW

public interface ITransport
extends IMotor

A public transport vehicle, a type of agent that carries people as passengers

Field Summary

Fields inherited from interface com.azalient.api.sim.agents.IMotor

ZERO

Fields inherited from interface com.azalient.api.sim.agents.IObstacle

ZERO_OBSTACLES

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

DELETED, KEY_SEP, KEY_SEP_CHAR

Method Summary

boolean	atStand() Returns true if this transport is currently at a stand
IDwell	currentDwell() The current dwell, which is null if the transport is not currently at a stand
UTime	departTime() Returns the time this transport leaves the next (or current) dwell point
void	departTime(UTime time) Sets the time this transport leaves the next (or current) dwell point
boolean	isLift() Returns true if this transport is a lift (a vertical transport vehicle on a single-transport demand-activated service)
IDwell	nextDwell() The next dwell at which this transport will stop
boolean	onLayover() Returns true if this transport is currently on a layover pause at a stand
IPassenger[]	passengerArray() Returns an array of passengers on this transport, or IPAssenger.ZERO if there are none
int	passengers() Returns the number of passengers on this transport
double	randomAlightTime(IPersonTrip trip) Returns an alighting time from the distribution defined for this transport, given the person trip
double	randomBoardTime(IPersonTrip trip) Returns a boarding time from the distribution defined for this transport, given the person trip
IService	service() The service that this transport is on
ITransportTrip	trip() [Return type specialisation] Returns the transport trip
double	tripDistance() Returns the trip distance so far, in metres.
ITransportType	type() [Return type specialisation] Returns the type of the transport
int	variation() The variation from the timetable, in seconds, where a negative value means ahead of timetable and a positive value is behind timetable.

Methods inherited from interface com.azalient.api.sim.agents.IMotor

allowStandingLaneChange, changeLane, colour, destinationIndex, exitChoice, exitLaneIndex, exitLaneIndex, extraPeople, followingModel, headFromPathStart, headToPathEnd, intersectionExit, isCycle, isTransport, kill, lane, laneHigh, laneHigh, laneIndex, laneK, laneLow, laneLow, laneLowHigh, laneM, laneOrderIndex, leaderMotor, link, nextLink, nextSurface, occupy, originIndex, people, reselectExit, routeExists, speed, startTime, stopped, stopped, stops, stream, streamOrderIndex, surface, type, unoccupy, uturn

Methods inherited from interface com.azalient.api.sim.agents.IAgent

acceleration, age, age, agentVision, arrived, attached, basePolygon, behaviour, blockedBy, blocker, centre, creationTime, emissionGrams, exclude, finished, followingAlgorithm, forward, freeMovingAlgorithm, frozen, gradient, halfLength, halfLengthHead, halfLengthTail, halfWidth, halted, halted, head, headDistance, headGroup, height, include, isAttached, keepSide, keepSide, leader, length, maxAcceleration, maxDeceleration, maxSpeedMPS, minimumGap, next, nextPathway, nextPathwayForward, pathPosition, pathway, pathwayFarthest, pathwayForward, perceivedHalfLengthHead, perceivedHalfWidth, reactionTime, selected, selected, specialMaxSpeed, speedMPS, steerFunction, steerToPathNow, stoppingDistance, tail, tailDistance, tailGroup, targetSpeedMPS, timeOnPathway, totalDistanceTravelled, totalTravelDistanceMetres, totalTravelStopsCount, totalTravelTimeSeconds, trackingMe, tripDetailRecord, twig, unblock, uniqueID, velocity, weightKG, width, zombie

Methods inherited from interface com.azalient.api.sim.detection.ILoopOccupier

loops

Methods inherited from interface com.azalient.api.sim.agents.IObstacle

annotationPoint

Methods inherited from interface com.azalient.api.a.IUserData

userData, userData, userDataHashCode

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.sim.agents.IBlocker

blocked, blockerDescription, blockPointDistance, doneBlocking, nowBlocking

Methods inherited from interface com.azalient.api.draw.IChangingDrawable

drawChangeables

Methods inherited from interface com.azalient.api.draw.IDrawable

canExplode, centroid, destroy, draw, isTransparent, name, remove, removed

Methods inherited from interface com.azalient.api.sim.agents.IRouteFinder

arrivesHere, routeExitIndex

Method Detail

type

ITransportType type()

[Return type specialisation] Returns the type of the transport

Specified by:

type in interface IAgent

Specified by:

type in interface IMotor

trip

ITransportTrip trip()

[Return type specialisation] Returns the transport trip

Specified by:

trip in interface IAgent

service

IService service()

The service that this transport is on

currentDwell

IDwell currentDwell()

The current dwell, which is null if the transport is not currently at a stand

nextDwell

IDwell nextDwell()

The next dwell at which this transport will stop

variation

int variation()

The variation from the timetable, in seconds, where a negative value means ahead of timetable and a positive value is behind timetable.

atStand

boolean atStand()

Returns true if this transport is currently at a stand

onLayover

boolean onLayover()

Returns true if this transport is currently on a layover pause at a stand

isLift

boolean isLift()

Returns true if this transport is a lift (a vertical transport vehicle on a single-transport demand-activated service)

passengers

int passengers()

Returns the number of passengers on this transport

passengerArray

IPassenger[] passengerArray()

Returns an array of passengers on this transport, or IPAssenger.ZERO if there are none

departTime

UTime departTime()

Returns the time this transport leaves the next (or current) dwell point

departTime

void departTime(UTime time)

Sets the time this transport leaves the next (or current) dwell point

tripDistance

double tripDistance()

Returns the trip distance so far, in metres.

randomBoardTime

double randomBoardTime(IPersonTrip trip)

Returns a boarding time from the distribution defined for this transport, given the person trip

randomAlightTime

double randomAlightTime(IPersonTrip trip)

Returns an alighting time from the distribution defined for this transport, given the person trip