model.map

Class Map

java.lang.Object

model.map.Map

public class Map
extends java.lang.Object

The map forms the basis for the agent-based model. It gathers all physical elements of the model and contains useful methods for interaction.

Author:

S.A.M. Janssen

Field Summary

Fields

Modifier and Type	Field and Description
private float	height The height of the map.
private com.google.common.collect.Multimap<java.lang.Class<?>,MapComponent>	mapComponents The MapComponents on the map.
private float	minimumHeight The minimum height of the map.
private float	minimumWidth The minimum width of the map.
private double	time The time.
private float	width The width of the map.

Constructor Summary

Constructors

Constructor and Description
Map() Creates a map that automatically scales to the items that are added.
Map(float width, float height) Creates the map with a minimum width and height.

Method Summary

Modifier and Type	Method and Description
void	add(MapComponent object) Adds a map component to the map.
private void	checkForAddIssues(MapComponent mapComponent) Checks if there is an issue by adding a MapComponent to the map.
float	getHeight() Gets the height of the map.
<T> java.util.Collection<T>	getMapComponents(java.lang.Class<T> className) Get all MapComponents that are an instance of a specific class.
double	getTime()
float	getWidth() Gets the width of the map.
boolean	isOutOfBounds(Position position) Check if a Position is out of map.
void	remove(MapComponent mapComponent) Remove a MapComponent from the map.
private void	updateDimensions() Updates the dimensions of the map.
void	updateTime(int timeStep) Update the time.

Methods inherited from class java.lang.Object

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

Field Detail

mapComponents

private com.google.common.collect.Multimap<java.lang.Class<?>,MapComponent> mapComponents

The MapComponents on the map. The Multimap is used as an internal representation to quickly find collections of MapComponents of a specified type. This results in some extra memory usage, but enables fast access times.

height

private float height

The height of the map.

width

private float width

The width of the map.

minimumHeight

private final float minimumHeight

The minimum height of the map.

minimumWidth

private final float minimumWidth

The minimum width of the map.

time

private double time

The time.

Constructor Detail

Map

public Map()

Creates a map that automatically scales to the items that are added.

Map

public Map(float width,
           float height)

Creates the map with a minimum width and height. The size increases if items are added that fall outside of the dimensions.

Parameters:

width - The minimum width of the map.

height - The minimum height of the map.

Method Detail

add

public void add(MapComponent object)

Adds a map component to the map.

Parameters:

object - The map component.

checkForAddIssues

private void checkForAddIssues(MapComponent mapComponent)

Checks if there is an issue by adding a MapComponent to the map. Throw an exception if there is.

Parameters:

mapComponent - The mapComponent.

getHeight

public float getHeight()

Gets the height of the map.

Returns:

The height.

getMapComponents

public <T> java.util.Collection<T> getMapComponents(java.lang.Class<T> className)

Get all MapComponents that are an instance of a specific class.

Type Parameters:

T - The class instance.

Parameters:

className - The class name.

Returns:

A Collection of the map components.

getTime

public double getTime()

Returns:

the time

getWidth

public float getWidth()

Gets the width of the map.

Returns:

The width.

isOutOfBounds

public boolean isOutOfBounds(Position position)

Check if a Position is out of map.

Parameters:

position - The position.

Returns:

True if it is out of the map, false otherwise.

remove

public void remove(MapComponent mapComponent)

Remove a MapComponent from the map.

Parameters:

mapComponent - The map component.

updateDimensions

private void updateDimensions()

Updates the dimensions of the map.

updateTime

public void updateTime(int timeStep)

Update the time. Only to be called by the simulator.

Parameters:

timeStep - The time step.