turtlekit.kernel

Class Patch

java.lang.Object

turtlekit.kernel.Patch

public class Patch
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
int	x
int	y

Constructor Summary

Constructors

Constructor and Description
Patch()

Method Summary

Methods

Modifier and Type	Method and Description
int	countTurtles()
void	dropMark(String markName, Object value) Drop a mark on the patch
void	dropPheromone(String name, float quantity, Float... parameters)
Color	getColor()
Object	getMark(String markName) get a mark deposed on the patch
Turtle	getNearestTurtle(int inRadius, boolean includeThisPatch) Gets the nearest turtle of type T in the vicinity of the patch.
<T extends Turtle> T	getNearestTurtle(int inRadius, boolean includeThisPatch, Class<T> turtleType) Gets the nearest turtle of type T in the vicinity of the patch.
List<Patch>	getNeighbors(int inRadius, boolean includeThisPatch)
List<Turtle>	getTurtles()
<T extends Turtle> List<T>	getTurtles(Class<T> turtleType) Get all the turtles on this patch according to their type.
List<Turtle>	getTurtles(int inRadius, boolean includeThisPatch)
<T extends Turtle> List<T>	getTurtles(int inRadius, boolean includeThisPatch, Class<T> turtleType)
List<Turtle>	getTurtlesWithRole(int inRadius, boolean includeThisPatch, String role)
<T extends Turtle> List<T>	getTurtlesWithRole(int inRadius, boolean includeThisPatch, String role, Class<T> turtleType)
<T extends Turtle> List<T>	getTurtlesWithRole(String role) Get all the turtles which are on this patch and having this role.
<T extends Turtle> List<T>	getTurtlesWithRole(String role, Class<T> turtleType) Get all the turtles on this patch according to their type and role.
boolean	isEmpty()
boolean	isMarkPresent(String markName) tests if the corresponding mark is present on the patch (true or false)
void	setColor(Color c)
void	setCoordinates(int x, int y)
void	setEnvironment(TKEnvironment environment)
String	toString()
protected void	update()

Methods inherited from class java.lang.Object

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

Field Detail

x

public int x

y

public int y

Constructor Detail

Patch

public Patch()

Method Detail

setCoordinates

public void setCoordinates(int x,
                  int y)

setEnvironment

public void setEnvironment(TKEnvironment environment)

isEmpty

public boolean isEmpty()

Returns:

true if there is no turtle

getNeighbors

public List<Patch> getNeighbors(int inRadius,
                       boolean includeThisPatch)

dropMark

public final void dropMark(String markName,
            Object value)

Drop a mark on the patch

Parameters:

markName - mark name

value - mark itself, can be any java object

getMark

public final Object getMark(String markName)

get a mark deposed on the patch

Returns:

the corresponding java object which thus is removed from the patch, or null if not present

isMarkPresent

public final boolean isMarkPresent(String markName)

tests if the corresponding mark is present on the patch (true or false)

getTurtles

public <T extends Turtle> List<T> getTurtles(int inRadius,
                                    boolean includeThisPatch,
                                    Class<T> turtleType)

getTurtlesWithRole

public <T extends Turtle> List<T> getTurtlesWithRole(int inRadius,
                                            boolean includeThisPatch,
                                            String role,
                                            Class<T> turtleType)

getTurtlesWithRole

public List<Turtle> getTurtlesWithRole(int inRadius,
                              boolean includeThisPatch,
                              String role)

getTurtles

public List<Turtle> getTurtles(int inRadius,
                      boolean includeThisPatch)

getNearestTurtle

public <T extends Turtle> T getNearestTurtle(int inRadius,
                                    boolean includeThisPatch,
                                    Class<T> turtleType)

Gets the nearest turtle of type T in the vicinity of the patch.

Parameters:

inRadius - the range of the search

includeThisPatch - for the search

turtleType - the type of the turtle as a Class

Returns:

the corresponding turtle or null if no such turtle is found

getNearestTurtle

public Turtle getNearestTurtle(int inRadius,
                      boolean includeThisPatch)

Gets the nearest turtle of type T in the vicinity of the patch.

Parameters:

inRadius - the range of the search

includeThisPatch - for the search

Returns:

the corresponding turtle or null if there is no turtle around

getTurtles

public <T extends Turtle> List<T> getTurtles(Class<T> turtleType)

Get all the turtles on this patch according to their type.

Parameters:

turtleType -

Returns:

a list of turtles which could be empty

getTurtlesWithRole

public <T extends Turtle> List<T> getTurtlesWithRole(String role,
                                            Class<T> turtleType)

Get all the turtles on this patch according to their type and role.

Parameters:

role -

turtleType -

Returns:

a list of turtles which could be empty

getTurtlesWithRole

public <T extends Turtle> List<T> getTurtlesWithRole(String role)

Get all the turtles which are on this patch and having this role.

Parameters:

role -

Returns:

a list of turtles which could be empty

getTurtles

public List<Turtle> getTurtles()

countTurtles

public int countTurtles()

getColor

public Color getColor()

setColor

public void setColor(Color c)

update

protected void update()

toString

public String toString()

Overrides:

toString in class Object

dropPheromone

public void dropPheromone(String name,
                 float quantity,
                 Float... parameters)