com.azalient.apo.enums
Enum AgentEvent

java.lang.Object
  java.lang.Enum<AgentEvent>
      com.azalient.apo.enums.AgentEvent

All Implemented Interfaces:

Serializable, Comparable<AgentEvent>

public enum AgentEvent
extends Enum<AgentEvent>

Events fired for agents in the simulation

Enum Constant Summary

ARRIVE
Fired when an agent arrives at a destination AgentEventArrive

DEPART
Fired when an agent departs form an origin AgentEventDepart

LANE
Fired when a vehicle changes lane AgentEventLane

LINK
Fired when a vehicle leaves or joins a link AgentEventLink

LOOP
Fired when a vehicle changes the state of a loop AgentEventLoop

MOVE
Fired for every agent on every move AgentEventMove

OCCUPANT_IN
Fired when a driver/passenger gets in to a private vehicle AgentEventOccupantIn

OCCUPANT_OUT
Fired when a driver/passenger gets out of a private vehicle AgentEventOccupantOut

PASSENGER_OFF
Fired when a passenger gets off public transport AgentEventPassengerOff

PASSENGER_ON
Fired when a passenger gets on to public transport AgentEventPassengerOn

SIGN
Fired when a vehicle passes a sign AgentEventSign

STAND
Fired when a public transport vehicle arrives at a stand AgentEventStand

STOP
Fired when an agent stops, as defined in the calibration parameters AgentEventStop

TEST_ARRIVAL
Fired when an agent is making an arrival decision AgentEventTestArrival

TEST_ROUTE
Fired when an agent is making a route decision AgentEventTestRoute

TIMESTEP
Fired for every agent at every time step AgentEventTimeStep

UNRELEASED
Fired when an agent can not be released at the origin because of congestion AgentEventUnreleased

WALKWAY
Fired when a person joins or leaves a walkway AgentEventWalkway

Method Summary

int	mask()
static AgentEvent	valueOf(String name) Returns the enum constant of this type with the specified name.
static AgentEvent[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DEPART

public static final AgentEvent DEPART

Fired when an agent departs form an origin AgentEventDepart

ARRIVE

public static final AgentEvent ARRIVE

Fired when an agent arrives at a destination AgentEventArrive

TIMESTEP

public static final AgentEvent TIMESTEP

Fired for every agent at every time step AgentEventTimeStep

MOVE

public static final AgentEvent MOVE

Fired for every agent on every move AgentEventMove

LOOP

public static final AgentEvent LOOP

Fired when a vehicle changes the state of a loop AgentEventLoop

SIGN

public static final AgentEvent SIGN

Fired when a vehicle passes a sign AgentEventSign

STAND

public static final AgentEvent STAND

Fired when a public transport vehicle arrives at a stand AgentEventStand

LINK

public static final AgentEvent LINK

Fired when a vehicle leaves or joins a link AgentEventLink

LANE

public static final AgentEvent LANE

Fired when a vehicle changes lane AgentEventLane

WALKWAY

public static final AgentEvent WALKWAY

Fired when a person joins or leaves a walkway AgentEventWalkway

TEST_ROUTE

public static final AgentEvent TEST_ROUTE

Fired when an agent is making a route decision AgentEventTestRoute

TEST_ARRIVAL

public static final AgentEvent TEST_ARRIVAL

Fired when an agent is making an arrival decision AgentEventTestArrival

UNRELEASED

public static final AgentEvent UNRELEASED

Fired when an agent can not be released at the origin because of congestion AgentEventUnreleased

STOP

public static final AgentEvent STOP

Fired when an agent stops, as defined in the calibration parameters AgentEventStop

PASSENGER_ON

public static final AgentEvent PASSENGER_ON

Fired when a passenger gets on to public transport AgentEventPassengerOn

PASSENGER_OFF

public static final AgentEvent PASSENGER_OFF

Fired when a passenger gets off public transport AgentEventPassengerOff

OCCUPANT_IN

public static final AgentEvent OCCUPANT_IN

Fired when a driver/passenger gets in to a private vehicle AgentEventOccupantIn

OCCUPANT_OUT

public static final AgentEvent OCCUPANT_OUT

Fired when a driver/passenger gets out of a private vehicle AgentEventOccupantOut

Method Detail

values

public static AgentEvent[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AgentEvent c : AgentEvent.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AgentEvent valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

mask

public int mask()