jadex.extension.envsupport.environment.space2d

Class Grid2D

java.lang.Object

jadex.commons.SimplePropertyObject

jadex.commons.meta.TypedPropertyObject

jadex.extension.envsupport.environment.SynchronizedPropertyObject

jadex.extension.envsupport.environment.AbstractEnvironmentSpace

jadex.extension.envsupport.environment.space2d.Space2D

jadex.extension.envsupport.environment.space2d.Grid2D

All Implemented Interfaces:

IExtensionInstance, IPropertyObject, ITypedPropertyObject, IEnvironmentSpace

public class Grid2D
extends Space2D

2D grid environment.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_NAME The default ID for this space.
static String	NEIGHBORHOOD_MOORE The moore neighborhood.
static String	NEIGHBORHOOD_VON_NEUMANN The von neumann neighborhood.
static String	PROPERTY_NEIGHBORHOOD The neighborhood property.

Fields inherited from class jadex.extension.envsupport.environment.space2d.Space2D

BORDER_RELAXED, BORDER_STRICT, BORDER_TORUS, PROPERTY_BORDER, PROPERTY_POSITION

Constructor Summary

Constructors

Constructor and Description
Grid2D() Creates a new ContinuousSpace2D with the default name.
Grid2D(IVector2 areasize) Creates a new ContinuousSpace2D with the default name.
Grid2D(Object name, IVector2 areasize) Creates a new ContinuousSpace2D with a special ID.

Method Summary

Methods

Modifier and Type	Method and Description
IVector1	calculateDistance(IVector1 dx, IVector1 dy) Calculate the distance in the space.
boolean	destroyAndVerifySpaceObject(Object id) Destroys an object in this space.
void	destroySpaceObject(Object id) Destroys an object in this space.
IVector2	getEmptyGridPosition() Get an empty position in the grid.
Set<SpaceObject>	getNearGridObjects(IVector2 position, int range, String[] types)
Set	getNearObjects(IVector2 position, IVector1 distance, String type) Retrieve all objects in the distance for a position.
String	getNeighborhood() Get the neighborhood.
IVector2	getRandomGridPosition(IVector2 distance) Retrieves a random position within the simulation area with a minimum distance from the edge.
IVector1	getShortestDirection(IVector1 pos1, IVector1 pos2, boolean isx) Get the shortest (direct) direction between two coordinates.
Collection<ISpaceObject>	getSpaceObjectsByGridPosition(IVector2 position, Object type) Get all SimObjects from a specific type at a specific grid position
void	initSpaceObject(ISpaceObject ret) Init an object in this space.
void	setAreaSize(IVector2 areasize) Set the area size.
void	setPosition(Object id, IVector2 pos) Set the position of an object.

Methods inherited from class jadex.extension.envsupport.environment.space2d.Space2D

addSpaceObjectType, adjustPosition, disableKdTree, enableKdTree, getAreaSize, getBorderMode, getDistance, getDistance, getNearestObject, getNearObjects, getNearObjects, getNearObjects, getRandomPosition, getSpaceObjects

Methods inherited from class jadex.extension.envsupport.environment.AbstractEnvironmentSpace

addAvatarMappings, addDataConsumer, addDataProvider, addDataView, addDataViewMapping, addEnvironmentListener, addInitialAvatar, addObjectTaskType, addPerceptGenerator, addPerceptProcessor, addPerceptType, addSpaceAction, addSpaceProcessType, addTaskListener, cancelSpaceAction, componentAdded, componentRemoved, createObjectTask, createPercept, createSpaceObject, createSpaceObjectZombie, createSpaceProcess, getAvatar, getAvatar, getAvatars, getClassLoader, getComponentActionList, getComponents, getDataConsumer, getDataConsumers, getDataProvider, getDataView, getDataViews, getExternalAccess, getFetcher, getOwner, getPerceptList, getPerceptType, getProcesses, getProperty, getSpaceAction, getSpaceObject, getSpaceObject0, getSpaceObjectsByType, getSpaceObjectsCollection, getSpaceProcess, getSpaceProcessNames, getViews, init, initSpace, performSpaceAction, performSpaceAction, removeAvatarMappings, removeDataView, removeEnvironmentListener, removeObjectTask, removeObjectTaskType, removePerceptGenerator, removePerceptProcessor, removePerceptType, removeSpaceAction, removeSpaceObjectType, removeSpaceProcess, removeSpaceProcessType, removeTaskListener, setFetcher, setInitData, setOwner, terminate, waitForTask

Methods inherited from class jadex.extension.envsupport.environment.SynchronizedPropertyObject

addPropertyChangeListener, getMonitor, getPropertyNames, hasProperty, removePropertyChangeListener, setProperty

Methods inherited from class jadex.commons.meta.TypedPropertyObject

getMetaData, getMetaDatas

Methods inherited from class jadex.commons.SimplePropertyObject

getProperties, setProperties, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface jadex.commons.IPropertyObject

getPropertyNames, hasProperty, setProperty

Field Detail

DEFAULT_NAME

public static final String DEFAULT_NAME

The default ID for this space.

NEIGHBORHOOD_MOORE

public static final String NEIGHBORHOOD_MOORE

The moore neighborhood.

See Also:

Constant Field Values

NEIGHBORHOOD_VON_NEUMANN

public static final String NEIGHBORHOOD_VON_NEUMANN

The von neumann neighborhood.

See Also:

Constant Field Values

PROPERTY_NEIGHBORHOOD

public static final String PROPERTY_NEIGHBORHOOD

The neighborhood property.

See Also:

Constant Field Values

Constructor Detail

Grid2D

public Grid2D()

Creates a new ContinuousSpace2D with the default name.

Parameters:

clockService - the clock service

timeCoefficient - the time coefficient for time differences.

areaSize - the size of the 2D area

Grid2D

public Grid2D(IVector2 areasize)

Creates a new ContinuousSpace2D with the default name.

Parameters:

actionexecutor - executor for component actions

areasize - the size of the 2D area

Grid2D

public Grid2D(Object name,
      IVector2 areasize)

Creates a new ContinuousSpace2D with a special ID.

Parameters:

name - the name of this space

areasize - the size of the 2D area

actionexecutor - executor for component actions

Method Detail

setAreaSize

public void setAreaSize(IVector2 areasize)

Set the area size.

Overrides:

setAreaSize in class Space2D

Parameters:

areasize - The area size.

getNeighborhood

public String getNeighborhood()

Get the neighborhood.

Returns:

Set the neighborhood.

getSpaceObjectsByGridPosition

public Collection<ISpaceObject> getSpaceObjectsByGridPosition(IVector2 position,
                                                     Object type)

Get all SimObjects from a specific type at a specific grid position

getEmptyGridPosition

public IVector2 getEmptyGridPosition()

Get an empty position in the grid.

Returns:

Empty IVector2 position.

getRandomGridPosition

public IVector2 getRandomGridPosition(IVector2 distance)

Retrieves a random position within the simulation area with a minimum distance from the edge.

Parameters:

distance - minimum distance from the edge, null or zero for no distance

setPosition

public void setPosition(Object id,
               IVector2 pos)

Set the position of an object.

Overrides:

setPosition in class Space2D

Parameters:

id - The object id.

pos - The object position.

initSpaceObject

public void initSpaceObject(ISpaceObject ret)

Init an object in this space.

Overrides:

initSpaceObject in class Space2D

destroyAndVerifySpaceObject

public boolean destroyAndVerifySpaceObject(Object id)

Destroys an object in this space.

Parameters:

objectId - the object's ID

destroySpaceObject

public void destroySpaceObject(Object id)

Destroys an object in this space.

Specified by:

destroySpaceObject in interface IEnvironmentSpace

Overrides:

destroySpaceObject in class AbstractEnvironmentSpace

Parameters:

objectId - the object's ID

getNearGridObjects

public Set<SpaceObject> getNearGridObjects(IVector2 position,
                                  int range,
                                  String[] types)

getNearObjects

public Set getNearObjects(IVector2 position,
                 IVector1 distance,
                 String type)

Retrieve all objects in the distance for a position. Uses position->object mapping, for fast operation.

Overrides:

getNearObjects in class Space2D

Parameters:

position - The position.

distance - The distance.

type - The type (or null for all objects).

Returns:

The near objects.

calculateDistance

public IVector1 calculateDistance(IVector1 dx,
                         IVector1 dy)

Calculate the distance in the space.

Overrides:

calculateDistance in class Space2D

Parameters:

dx - The distance in x.

dy - The distance in y.

Returns:

The distance according to the distance metrics of the space.

getShortestDirection

public IVector1 getShortestDirection(IVector1 pos1,
                            IVector1 pos2,
                            boolean isx)

Get the shortest (direct) direction between two coordinates.

Parameters:

pos1 - The first position.

pos2 - The second position.

isx - The flag indicating if x or y).

Returns:

-1: left/down, +1: right/up, 0: no move