model.agent.humanAgent.aatom.tacticalLevel.navigation

Class NavigationModule

java.lang.Object

model.agent.humanAgent.aatom.tacticalLevel.navigation.NavigationModule

All Implemented Interfaces:

Updatable

Direct Known Subclasses:

OperatorNavigationModule, PassengerNavigationModule

public class NavigationModule
extends java.lang.Object
implements Updatable

The goal activity is responsible for the goal setting of the agent. It determines if the agent is stuck, and updates itself accordingly. It also allows for external parties to influence the goals, using the 'set' methods.

Author:

S.A.M. Janssen

Field Summary

Fields

Modifier and Type	Field and Description
protected ActivityModule	activityModule The activity module.
protected java.util.List<Position>	goalPositions The goal Positions.
private double	goalRefreshTime Goal refresh counter.
private Map	map The map.
protected MovementModule	movementModel The movement model.
protected ObservationModule	observationModule The observation module.
protected PathFinder	pathFinder The method to determine our path.
protected StuckDetector	stuckDetector The stuck detector.

Constructor Summary

Constructors

Constructor and Description
NavigationModule() Create a goal activity.
NavigationModule(java.util.List<Position> goalPositions) Creates a goal activity.

Method Summary

Modifier and Type	Method and Description
Position	getGoalPosition() Gets the closest goal position.
java.util.List<Position>	getGoalPositions() Gets the goal positions.
private Position	getQueueGoal() Gets the queue goal.
boolean	getReachedGoal() Determines if the goal is reached.
protected void	handleStuckBehavior(int timeStep) Handles the behavior if the agent gets stuck.
void	init(Map map, MovementModule movementModel, ActivityModule activityModule, ObservationModule observationModule) Sets the agent.
private boolean	inQueuingArea() Determines if the agent is in a queuing area.
private boolean	isCollision(int goalIndex) Check if there is a collision with PhysicalObjects or WalkThroughMetalDetectors.
private boolean	isQueuing() Determines if the agent is queuing.
boolean	isStuck(double secondsStuck) Determines if the agent is stuck for a given number of seconds.
private boolean	reachedGoal(int goalIndex) Checks if the goal at a specified index is reached.
protected void	removeGoals(int numberOfGoals) Remove a number of goals from the list.
void	setGoal(Position position) Sets the goal position.
void	setShortTermGoal(Position position) Set a short term goal position.
void	setShortTermGoals(java.util.List<Position> positions) Sets a set of short term positions.
void	update(int timeStep) Updates the updatable element.
protected void	updateReachedGoals(int timeStep) Update the goals based on the place that the agent is currently located.

Methods inherited from class java.lang.Object

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

Field Detail

goalPositions

protected java.util.List<Position> goalPositions

The goal Positions.

goalRefreshTime

private double goalRefreshTime

Goal refresh counter.

pathFinder

protected PathFinder pathFinder

The method to determine our path.

stuckDetector

protected StuckDetector stuckDetector

The stuck detector.

movementModel

protected MovementModule movementModel

The movement model.

observationModule

protected ObservationModule observationModule

The observation module.

activityModule

protected ActivityModule activityModule

The activity module.

map

private Map map

The map.

Constructor Detail

NavigationModule

public NavigationModule()

Create a goal activity.

NavigationModule

public NavigationModule(java.util.List<Position> goalPositions)

Creates a goal activity.

Parameters:

goalPositions - The goal positions.

Method Detail

getGoalPosition

public Position getGoalPosition()

Gets the closest goal position.

Returns:

Tue closest goal position.

getGoalPositions

public java.util.List<Position> getGoalPositions()

Gets the goal positions.

Returns:

The goal positions.

getQueueGoal

private Position getQueueGoal()

Gets the queue goal.

Returns:

The goal.

getReachedGoal

public boolean getReachedGoal()

Determines if the goal is reached.

Returns:

True if the goal is reached, false otherwise.

handleStuckBehavior

protected void handleStuckBehavior(int timeStep)

Handles the behavior if the agent gets stuck.

Parameters:

timeStep - The time step.

init

public void init(Map map,
                 MovementModule movementModel,
                 ActivityModule activityModule,
                 ObservationModule observationModule)

Sets the agent.

Parameters:

map - The map.

movementModel - The movement model.

activityModule - The activity module.

observationModule - The observation module.

inQueuingArea

private boolean inQueuingArea()

Determines if the agent is in a queuing area.

Returns:

True if it is, false otherwise.

isCollision

private boolean isCollision(int goalIndex)

Check if there is a collision with PhysicalObjects or WalkThroughMetalDetectors.

Parameters:

goalIndex - The index of the goal position.

Returns:

True if there is, false otherwise.

isQueuing

private boolean isQueuing()

Determines if the agent is queuing.

Returns:

True if it is, false otherwise.

isStuck

public boolean isStuck(double secondsStuck)

Determines if the agent is stuck for a given number of seconds. Stuck is defined as moving at most 0.2m in secondsStuck seconds.

Parameters:

secondsStuck - The number of seconds it takes before an agent is considered stuck.

Returns:

True if the agent is stuck, false otherwise.

reachedGoal

private boolean reachedGoal(int goalIndex)

Checks if the goal at a specified index is reached.

Parameters:

goalIndex - The index.

Returns:

True if reached, false otherwise

removeGoals

protected void removeGoals(int numberOfGoals)

Remove a number of goals from the list.

Parameters:

numberOfGoals - The number of goals.

setGoal

public void setGoal(Position position)

Sets the goal position.

Parameters:

position - The position.

setShortTermGoal

public void setShortTermGoal(Position position)

Set a short term goal position.

Parameters:

position - The position.

setShortTermGoals

public void setShortTermGoals(java.util.List<Position> positions)

Sets a set of short term positions.

Parameters:

positions - The positions.

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

updateReachedGoals

protected void updateReachedGoals(int timeStep)

Update the goals based on the place that the agent is currently located.

Parameters:

timeStep - The time step.