com.azalient.api.sim.agents
Interface IAgentLocator

public interface IAgentLocator

The agent-locator object chooses a location for a new agent. This process is more complex for a vehicle, especially on multi-lane links, as there may be rules governing which lane is best

Method Summary

int	bay() [Vehicles Only] Returns the parking bay number, if the new vehicles is parked
IXyz	centre() [Vehicles Only] Returns the position for new (vehicle) agent
ILane	lane() [Vehicles Only] Returns the initial lane
int	laneHigh() [Vehicles Only] Returns the high end of the lane range, 1..N
int	laneLow() [Vehicles Only] Returns the low end of the lane range, 1..N
int	nextlane() [Vehicles Only] Returns the lane on the subsequent link.
Speed	speed() Returns the initial speed of the agent

Method Detail

speed

Speed speed()

Returns the initial speed of the agent

lane

ILane lane()

[Vehicles Only] Returns the initial lane

nextlane

int nextlane()

[Vehicles Only] Returns the lane on the subsequent link. 0 means not set, or 1..N

laneLow

int laneLow()

[Vehicles Only] Returns the low end of the lane range, 1..N

laneHigh

int laneHigh()

[Vehicles Only] Returns the high end of the lane range, 1..N

bay

int bay()

[Vehicles Only] Returns the parking bay number, if the new vehicles is parked

centre

IXyz centre()

[Vehicles Only] Returns the position for new (vehicle) agent