com.azalient.api.event.agent
Interface AgentEventTestArrival

public interface AgentEventTestArrival

An active listener that is notified each time step and asked if an agent is about to arrive at its destination. Unlike most other events, this is not just a notification, but an opportunity to change the behaviour

Method Summary

boolean

testArrival(IAgent agent, ITwig twig, boolean arrived) This is called to test if an agent has arrived at its destination.

Method Detail

testArrival

boolean testArrival(IAgent agent,
                    ITwig twig,
                    boolean arrived)

This is called to test if an agent has arrived at its destination. Unlike most other events, this is not just a notification, but an opportunity to change the behaviour.

Parameters:

agent - The agent (person or vehicle) under test

twig - The routing twig (branch) where the agent is

arrived - the arrival status as calculated by the standard algorithms. This can be used in the plugin as part of the logic to determine if this agent has now arrived.

Returns:

true if the agent should arrive now, or false if should not arrive now