model.agent.humanAgent.aatom.operationalLevel

Class OperationalModel

java.lang.Object

model.agent.humanAgent.aatom.operationalLevel.OperationalModel

All Implemented Interfaces:

Updatable

Direct Known Subclasses:

BasicOperatorOperationalModel, BasicPassengerOperationalModel

public abstract class OperationalModel
extends java.lang.Object
implements Updatable

A low level model handles observations and movement of an agent.

Author:

S.A.M. Janssen

Field Summary

Fields

Modifier and Type	Field and Description
private CommunicationModule	communicationModule The communication module.
private MovementModule	movementModel The movement model.
private ObservationModule	observationModule The observation module.

Constructor Summary

Constructors

Constructor and Description
OperationalModel(MovementModule movementModel, ObservationModule observationModule, CommunicationModule communicationModule)

Method Summary

Modifier and Type	Method and Description
void	communicate(CommunicationType type, java.lang.Object communication) Communicate.
Vector	getCurrentVelocity() Gets the current velocity.
double	getDesiredSpeed() Gets the desired speed.
Vector	getMove(int timeStep) Gets the next move given a certain time step.
MovementModule	getMovementModel() Gets the movement model.
<T> java.util.Collection<T>	getObservation(java.lang.Class<T> type) Gets an observation of a specific type.
ObservationModule	getObservationModule() Gets the observation module.
boolean	getStopOrder() Indicates if the agent has a stop order.
void	init(Map map, AatomHumanAgent agent, NavigationModule navigationModule, ActivityModule activityModule) Initializes the AatomHumanAgent.
boolean	isSitting() Determines if the agent is sitting.
boolean	setSitDown(Chair chair) Asks the agent to sit down on a specific Chair.
void	setStopOrder(double stopOrder) Sets a flag that indicates if the agent is ordered to stop.
void	update(int timeStep) Updates the updatable element.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

movementModel

private MovementModule movementModel

The movement model.

observationModule

private ObservationModule observationModule

The observation module.

communicationModule

private CommunicationModule communicationModule

The communication module.

Constructor Detail

OperationalModel

public OperationalModel(MovementModule movementModel,
                        ObservationModule observationModule,
                        CommunicationModule communicationModule)

Parameters:

movementModel - The movement model.

observationModule - The observation module.

communicationModule - The communication module.

Method Detail

communicate

public void communicate(CommunicationType type,
                        java.lang.Object communication)

Communicate.

Parameters:

type - The type of communication.

communication - The communication.

getCurrentVelocity

public Vector getCurrentVelocity()

Gets the current velocity.

Returns:

The current velocity.

getDesiredSpeed

public double getDesiredSpeed()

Gets the desired speed.

Returns:

The desired speed.

getMove

public Vector getMove(int timeStep)

Gets the next move given a certain time step.

Parameters:

timeStep - The time step.

Returns:

The move.

getMovementModel

public MovementModule getMovementModel()

Gets the movement model.

Returns:

The movement model.

getObservation

public <T> java.util.Collection<T> getObservation(java.lang.Class<T> type)

Gets an observation of a specific type. An observation always returns a collection of map components.

Type Parameters:

T - The type of observation.

Parameters:

type - The map component.

Returns:

The collection that is observed.

getObservationModule

public ObservationModule getObservationModule()

Gets the observation module.

Returns:

The observation module.

getStopOrder

public boolean getStopOrder()

Indicates if the agent has a stop order. It will also make sure that the agent stops if someone in its very close neighborhood has a stop order.

Returns:

True if he is ordered to stop, false otherwise.

init

public void init(Map map,
                 AatomHumanAgent agent,
                 NavigationModule navigationModule,
                 ActivityModule activityModule)

Initializes the AatomHumanAgent.

Parameters:

map - The map.

agent - The agent.

navigationModule - The navigation module.

activityModule - The activity module.

isSitting

public boolean isSitting()

Determines if the agent is sitting.

Returns:

True if the agent is sitting, false otherwise.

setSitDown

public boolean setSitDown(Chair chair)

Asks the agent to sit down on a specific Chair. Returns true if successful, false otherwise.

Parameters:

chair - The chair.

Returns:

true if successful, false otherwise.

setStopOrder

public void setStopOrder(double stopOrder)

Sets a flag that indicates if the agent is ordered to stop.

Parameters:

stopOrder - The time of the stop order.

update

public void update(int timeStep)

Description copied from interface: Updatable

Updates the updatable element.

Specified by:

update in interface Updatable

Parameters:

timeStep - The time step of the simulation (in milliseconds).