model.agent.humanAgent.aatom.operationalLevel.action.movement

Class MovementModule

java.lang.Object

model.agent.humanAgent.aatom.operationalLevel.action.movement.MovementModule

All Implemented Interfaces:

Updatable

Direct Known Subclasses:

BasicMovementModule, HelbingMovementModule, RandomMovementModule, StaticMovementModule

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

A movement model is responsible for the movement of a passenger.

Author:

S.A.M. Janssen

Field Summary

Fields

Modifier and Type	Field and Description
AatomHumanAgent	agent The agent.
private Chair	chair The chair the agent is sitting on.
protected Vector	currentVelocity The current velocity.
protected double	desiredSpeed The desired speed.
protected ObservationModule	observationModule The observation module.
private double	stopMovingTime The time that the agent still needs to stop moving.

Constructor Summary

Constructors

Constructor and Description
MovementModule(double desiredSpeed) Creates a movement model.

Method Summary

Modifier and Type	Method and Description
protected Vector	boundSpeed(Vector vector) Bounds the speed of a movement to a maximum of 1.5 the desired speed.
Chair	getChair() Gets the chair the agent is sitting on.
Vector	getCurrentVelocity() Gets the current velocity.
double	getDesiredSpeed() Gets the desired speed.
abstract Vector	getMove(int timeStep) Gets the next move.
Position	getPosition() Gets the position of the agent.
double	getStopMovingTime() Get the remaining stop moving time.
boolean	getStopOrder() Indicates if the agent has a stop order.
void	init(AatomHumanAgent agent, ObservationModule observationModule) Sets the agent.
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 the time that indicates if the time 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

agent

public AatomHumanAgent agent

The agent. TODO fix

currentVelocity

protected Vector currentVelocity

The current velocity.

desiredSpeed

protected double desiredSpeed

The desired speed.

chair

private Chair chair

The chair the agent is sitting on. Null if not sitting.

stopMovingTime

private double stopMovingTime

The time that the agent still needs to stop moving. If this is -1, the time is infinite.

observationModule

protected ObservationModule observationModule

The observation module.

Constructor Detail

MovementModule

public MovementModule(double desiredSpeed)

Creates a movement model.

Parameters:

desiredSpeed - The desired speed.

Method Detail

boundSpeed

protected Vector boundSpeed(Vector vector)

Bounds the speed of a movement to a maximum of 1.5 the desired speed.

Parameters:

vector - The movement.

Returns:

The movement bounded with a maximum speed.

getDesiredSpeed

public double getDesiredSpeed()

Gets the desired speed.

Returns:

The desired speed.

getChair

public Chair getChair()

Gets the chair the agent is sitting on. Null if not sitting.

Returns:

The chair the agent is sitting on. Null if not sitting.

getCurrentVelocity

public Vector getCurrentVelocity()

Gets the current velocity.

Returns:

The current velocity.

getMove

public abstract Vector getMove(int timeStep)

Gets the next move. When overriding this method, please ensure that you scalar multiply the generated vector with the timestep/1000.0, and update the field currentVelocity to the generated value.

Parameters:

timeStep - The time step (in milliseconds).

Returns:

The next move.

getPosition

public Position getPosition()

Gets the position of the agent.

Returns:

The position.

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.

getStopMovingTime

public double getStopMovingTime()

Get the remaining stop moving time.

Returns:

The remaining time to stop moving.

init

public void init(AatomHumanAgent agent,
                 ObservationModule observationModule)

Sets the agent.

Parameters:

agent - The agent.

observationModule - The observation 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 the Position of the chair if he will sit down, returns Position.NO_POSITION if he will not.

Parameters:

chair - The chair.

Returns:

The position of the chair if he will sit down, and no position if he will not.

setStopOrder

public void setStopOrder(double stopOrder)

Sets the time that indicates if the time to stop.

Parameters:

stopOrder - The stopping time.

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).