com.azalient.api.sim.agents
Interface IOccupant

public interface IOccupant

An occupant represents a person (or person-group) travelling in/on a private vehicle.

An occupant may be the driver of a vehicle (for parking) or a the passenger (for pick-up, drop-off and taxi trips)

Method Summary

boolean	aboard() Returns true if the occupant is "in" the vehicle, not in transition
boolean	arrived() Returns true if the vehicle has arrived at its (parking / drop-off / transition) destination zone
IZone	destination() The zone at which the occupant will leave the vehicle.
Object	origin() The parking lane or zone at which the occupant will board the vehicle
IPerson	person() The person, defined by the person-trip
boolean	readyToBoard() Returns true if the occupant is ready to board the vehicle (near enough to the vehicle)
boolean	readyToDepart() Returns true if the occupant's vehicle is ready to depart from the parking bay
IVehicle	vehicle() The vehicle being used

Method Detail

person

IPerson person()

The person, defined by the person-trip

vehicle

IVehicle vehicle()

The vehicle being used

origin

Object origin()

The parking lane or zone at which the occupant will board the vehicle

destination

IZone destination()

The zone at which the occupant will leave the vehicle.

aboard

boolean aboard()

Returns true if the occupant is "in" the vehicle, not in transition

arrived

boolean arrived()

Returns true if the vehicle has arrived at its (parking / drop-off / transition) destination zone

readyToDepart

boolean readyToDepart()

Returns true if the occupant's vehicle is ready to depart from the parking bay

readyToBoard

boolean readyToBoard()

Returns true if the occupant is ready to board the vehicle (near enough to the vehicle)