turtlekit.kernel

Class TKEnvironment

java.lang.Object

madkit.kernel.AbstractAgent

madkit.kernel.Watcher

turtlekit.kernel.TKEnvironment

All Implemented Interfaces:

Comparable<AbstractAgent>

public class TKEnvironment
extends Watcher

Nested Class Summary

Nested classes/interfaces inherited from class madkit.kernel.AbstractAgent

AbstractAgent.ReturnCode, AbstractAgent.State

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	GPU_GRADIENTS

Fields inherited from class madkit.kernel.AbstractAgent

logger

Constructor Summary

Constructors

Constructor and Description
TKEnvironment()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	activate()
protected Pheromone	createCudaPheromone(String name, float evaporationPercentage, float diffusionPercentage)
int	createTurtle(Turtle t) Launch a turtle with a random location
int	createTurtle(Turtle t, double x, double y) Launch a turtle with predefined coordinates
protected static void	executeThisEnvironment(String... args) This offers a convenient way to create a main method that launches a simulation using the environment class under development.
int	get1DIndex(int xcor, int ycor)
int	getHeight()
protected Patch	getPatch(int i, int j)
protected Patch[]	getPatchGrid()
Pheromone	getPheromone(String name) Gets the corresponding pheromone or create a new one using defaults parameters : 50% for both the evaporation rate and the diffusion rate.
Pheromone	getPheromone(String name, float evaporationPercentage, float diffusionPercentage) Gets the corresponding pheromone or create a new one using the parameters if available: The first float is the evaporation rate and the second is the diffusion rate.
Pheromone	getPheromone(String name, int evaporationPercentage, int diffusionPercentage) Gets the corresponding pheromone or create a new one using the parameters if available: The first float is the evaporation rate and the second is the diffusion rate.
Collection<Pheromone>	getPheromones()
List<Turtle>	getTurtlesWithRoles(String role) Gets the turtles with this role in the default community and group
List<Turtle>	getTurtlesWithRoles(String community, String group, String role)
int	getWidth()
boolean	isCudaOn()
double	normalizeX(double x) Returns the normalized value of x, so that it is inside the environment's boundaries
double	normalizeX(int x) Returns the normalized value of x, so that it is inside the environment's boundaries
double	normalizeY(double y) Returns the normalized value of y, so that it is inside the environment's boundaries
double	normalizeY(int y) Returns the normalized value of y, so that it is inside the environment's boundaries
protected void	resetPheroMaxValues() reset max values for rendering purposes
void	synchronizeEnvironment(boolean synchronizedEnvironment) Keep the agents synchronized with the environment dynamics
protected void	update()

Methods inherited from class madkit.kernel.Watcher

addProbe, allProbes, getProbes, removeAllProbes, removeProbe, toString

Methods inherited from class madkit.kernel.AbstractAgent

broadcastMessage, broadcastMessageWithRole, bucketModeCreateGroup, bucketModeRequestRole, checkAgentAddress, compareTo, createGroup, createGroup, createGroup, createGroupIfAbsent, createGroupIfAbsent, createGroupIfAbsent, createGUIOnStartUp, destroyCommunity, destroyGroup, destroyRole, end, executeThisAgent, executeThisAgent, executeThisAgent, getAgentAddressIn, getAgentsWithRole, getAgentsWithRole, getAgentWithRole, getDistantAgentWithRole, getExistingCommunities, getExistingGroups, getExistingRoles, getKernelAddress, getLogger, getMadkitConfig, getMadkitProperty, getMadkitProperty, getMyGroups, getMyRoles, getName, getNetworkID, getOrganizationSnapShot, getReplyTo, getServerInfo, getSimpleNetworkID, getState, hasGUI, hashCode, hasRole, isAlive, isCommunity, isGroup, isKernelOnline, isMadkitPropertyTrue, isMessageBoxEmpty, isRole, killAgent, killAgent, launchAgent, launchAgent, launchAgent, launchAgent, launchAgent, launchAgent, launchAgent, launchAgent, launchAgentBucket, launchAgentBucket, launchAgentBucket, launchAgentBucket, launchNode, launchXmlAgents, leaveGroup, leaveRole, nextMessage, nextMessage, nextMessages, proceedEnumMessage, purgeMailbox, receiveMessage, reload, requestRole, requestRole, sendMessage, sendMessage, sendMessageWithRole, sendMessageWithRole, sendReply, sendReplyWithRole, setLogLevel, setMadkitProperty, setMadkitProperty, setName, setupFrame

Methods inherited from class java.lang.Object

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

Field Detail

GPU_GRADIENTS

protected boolean GPU_GRADIENTS

Constructor Detail

TKEnvironment

public TKEnvironment()

Method Detail

getPheromones

public Collection<Pheromone> getPheromones()

activate

protected void activate()

Overrides:

activate in class Watcher

getPatch

protected Patch getPatch(int i,
             int j)

normalizeX

public final double normalizeX(double x)

Returns the normalized value of x, so that it is inside the environment's boundaries

Parameters:

x - x-coordinate

Returns:

the normalized value

normalizeY

public final double normalizeY(double y)

Returns the normalized value of y, so that it is inside the environment's boundaries

Parameters:

y - y-coordinate

Returns:

the normalized value

normalizeX

public final double normalizeX(int x)

Returns the normalized value of x, so that it is inside the environment's boundaries

Parameters:

x - x-coordinate

Returns:

the normalized value

normalizeY

public final double normalizeY(int y)

Returns the normalized value of y, so that it is inside the environment's boundaries

Parameters:

y - y-coordinate

Returns:

the normalized value

get1DIndex

public int get1DIndex(int xcor,
             int ycor)

Parameters:

x - absolute

y - absolute

Returns:

the absolute index in a 1D data grid representing a 2D grid of width,height size. This should be used with Turtle.xcor() and Turtle.ycor(). Its purpose is to be used on a Pheromone

update

protected void update()

createTurtle

public int createTurtle(Turtle t,
               double x,
               double y)

Launch a turtle with predefined coordinates

Parameters:

t -

x -

y -

Returns:

the ID given to the turtle

createTurtle

public int createTurtle(Turtle t)

Launch a turtle with a random location

Parameters:

t -

Returns:

the ID given to the turtle

resetPheroMaxValues

protected void resetPheroMaxValues()

reset max values for rendering purposes

getWidth

public int getWidth()

getHeight

public int getHeight()

getPheromone

public Pheromone getPheromone(String name)

Gets the corresponding pheromone or create a new one using defaults parameters : 50% for both the evaporation rate and the diffusion rate.

Parameters:

name - the pheromone's name

Returns:

the pheromone

getPheromone

public Pheromone getPheromone(String name,
                     int evaporationPercentage,
                     int diffusionPercentage)

Gets the corresponding pheromone or create a new one using the parameters if available: The first float is the evaporation rate and the second is the diffusion rate.

Parameters:

name - the pheromone's name

parameters - the first float is the evaporation rate and the second is the diffusion rate.

Returns:

the pheromone

getPheromone

public Pheromone getPheromone(String name,
                     float evaporationPercentage,
                     float diffusionPercentage)

Gets the corresponding pheromone or create a new one using the parameters if available: The first float is the evaporation rate and the second is the diffusion rate.

Parameters:

name - the pheromone's name

parameters - the first float is the evaporation rate and the second is the diffusion rate.

Returns:

the pheromone

createCudaPheromone

protected Pheromone createCudaPheromone(String name,
                            float evaporationPercentage,
                            float diffusionPercentage)

getTurtlesWithRoles

public List<Turtle> getTurtlesWithRoles(String community,
                               String group,
                               String role)

Parameters:

community - the group's community.

group - the targeted group.

role - the desired role.

Returns:

a list of Turtles currently having this role

getTurtlesWithRoles

public List<Turtle> getTurtlesWithRoles(String role)

Gets the turtles with this role in the default community and group

Parameters:

role -

Returns:

a list of turtles

getPatchGrid

protected final Patch[] getPatchGrid()

Returns:

the patchGrid

executeThisEnvironment

protected static void executeThisEnvironment(String... args)

This offers a convenient way to create a main method that launches a simulation using the environment class under development. This call only works in the main method of the environment.

Parameters:

args - MaDKit or TurtleKit options

Since:

TurtleKit 3.0.0.1

See Also:

AbstractAgent.executeThisAgent(int, boolean, String...)

isCudaOn

public boolean isCudaOn()

Returns:

the cudaOn

synchronizeEnvironment

public void synchronizeEnvironment(boolean synchronizedEnvironment)

Keep the agents synchronized with the environment dynamics

Parameters:

synchronizedEnvironment -