model.agent

Class Agent

java.lang.Object

model.map.MapComponent

model.map.PhysicalMapComponent

model.map.shapes.CircularMapComponent

model.agent.Agent

All Implemented Interfaces:

CircularShape, DirectlyUpdatable, SimulationObject, Updatable

Direct Known Subclasses:

HumanAgent

public abstract class Agent
extends CircularMapComponent
implements DirectlyUpdatable

An agent is an entity that is able to act. Its method update(int) will be called at every iteration in the simulation. It is assumed to be circular, but can have a radius of 0 (which is the default).

Author:

S.A.M. Janssen

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String[]	log The log value.

Fields inherited from class model.map.PhysicalMapComponent

position

Fields inherited from class model.map.MapComponent

map

Constructor Summary

Constructors

Constructor and Description
Agent(Position position) Creates an agent at a specific Position with a 0 radius.
Agent(Position position, double radius) Creates an agent at a specific Position.

Method Summary

Modifier and Type	Method and Description
protected abstract <T> java.util.Collection<T>	getObservation(java.lang.Class<T> type) Gets an observation of a specific type.
void	init() This method is used to initialize the agent.
void	setLog(java.lang.String[] log) Sets the log value.
void	update(int timeStep) Updates the updatable element.
abstract boolean	wantsToBeDestoryed() Determines if the agent wants to be removed from the simulation.
java.lang.String[]	writeLog() Gets the log of the agent and empties it.

Methods inherited from class model.map.shapes.CircularMapComponent

getRadius, getVectorToPosition, isLineCollision

Methods inherited from class model.map.PhysicalMapComponent

getDistance, getPosition

Methods inherited from class model.map.MapComponent

isDestroyed

Methods inherited from class java.lang.Object

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

Field Detail

log

private java.lang.String[] log

The log value.

Constructor Detail

Agent

public Agent(Position position)

Creates an agent at a specific Position with a 0 radius.

Parameters:

position - The position.

Agent

public Agent(Position position,
             double radius)

Creates an agent at a specific Position.

Parameters:

position - The position.

radius - The radius of the agent.

Method Detail

getObservation

protected abstract <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.

wantsToBeDestoryed

public abstract boolean wantsToBeDestoryed()

Determines if the agent wants to be removed from the simulation.

Returns:

True if it does, false otherwise.

init

public void init()

This method is used to initialize the agent.

setLog

public void setLog(java.lang.String[] log)

Sets the log value.

Parameters:

log - The log.

writeLog

public java.lang.String[] writeLog()

Gets the log of the agent and empties it. Only to be used by the logging classes.

Returns:

The log.

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