com.azalient.api.event.agent
Interface AgentEventTestRoute

All Known Subinterfaces:

IPersonRouter, IRouter, IVehicleRouter

public interface AgentEventTestRoute

An active listener that is notified each time step and asked which route exit an agent should choose from its current location. Unlike most other events, this is not just a notification, but an opportunity to change the behaviour

Method Summary

int	testRoute(IAgent agent, ITwig twig, int exit) This is called to offer an opportunity to change the routing exit an agent will take from its current location.

Method Detail

testRoute

int testRoute(IAgent agent,
              ITwig twig,
              int exit)

This is called to offer an opportunity to change the routing exit an agent will take from its current location. 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

exit - the routing exit as calculated by the standard algorithms. This default value can be used in the plugin as part of the logic to determine the best exit.

Returns:

the chosen exit, by its index