Turtle (TurtleKit 3.0.0.4)

java.lang.Object
- madkit.kernel.AbstractAgent
- - turtlekit.kernel.Turtle

All Implemented Interfaces:

Comparable<AbstractAgent>
```
public class Turtle
extends AbstractAgent
```

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 Color color
The turtle's color.

protected static Random generator
The turtle's PRNG //TODO have a real model
- Fields inherited from class madkit.kernel.AbstractAgent
  logger

Fields
Modifier and Type	Field and Description
`protected Color`	`color` The turtle's color.
`protected static Random`	`generator` The turtle's PRNG //TODO have a real model

Constructor Summary

Constructors
Constructor and Description

Turtle()

Turtle(String initMethod)

Constructors
Constructor and Description
`Turtle()`
`Turtle(String initMethod)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`activate()`
`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
`int`	`createTurtleHere(Turtle t)` launch a turtle at the creator position (xcor,ycor) and returns the given ID to the new turtle
`String`	`defaultBehavior()`
`double`	`distance(double a, double b)` returns the distance from the patch (a,b).
`double`	`distance(Turtle t)`
`double`	`distanceNoWrap(double xCoordinate, double yCoordinate)` return the "on screen distance" between the turtle and the coordinates (a,b).
`int`	`dx()` return the x-increment if the turtle were to take one step forward in its current heading.
`int`	`dy()` return the int y-increment if the turtle were to take one step forward in its current heading.
`protected void`	`emit(String pheromone, float value)` Shortcut for `getPheromone(pheromone).incValue(xcor(), ycor(), value);`
`protected static TurtleKit`	`executeThisTurtle(int nbOfInstances, String... args)` This offers a convenient way to create a main method that launches a simulation containing the turtle class under development.
`void`	`fd(double nb)` Makes turtle moves forward of nb space units
`int`	`get1DIndex()`
`int`	`get1DIndex(int x, int y)`
`Color`	`getColor()`
`String`	`getCommunity()`
`int`	`getCurrentBehaviorCount()` When the turtle switches its behavior the value of this counter is 0
`TKEnvironment`	`getEnvironment()`
`float`	`getFieldValue(Pheromone p)`
`double`	`getHeading()` return the current heading of the turtle
`int`	`getID()` the id of this turtle
`int`	`getMaxDirection(Pheromone p)`
`int`	`getMinDirection(Pheromone p)`
`<T extends Turtle> T`	`getNearestTurtle(double realRadius, Class<T> turtleType)` Returns the nearest turtle of type T from this one according to its real distance.
`Turtle`	`getNearestTurtle(int inRadius)` Returns the nearest turtle from this one within the inRadius-vicinity as a patch distance.
`<T extends Turtle> T`	`getNearestTurtle(int patchRadius, Class<T> turtleType)` Returns the nearest turtle of type T from this one according to its patch distance.
`Turtle`	`getNearestTurtleWithRole(int patchRadius, String role)` Returns the nearest turtle of type T from this one according to its patch distance.
`<T extends Turtle> T`	`getNearestTurtleWithRole(int patchRadius, String role, Class<T> turtleType)` Returns the nearest turtle of type T from this one according to its patch distance.
`Patch`	`getNextPatch()`
`List<Turtle>`	`getOtherTurtles(int inRadius, boolean includeThisPatch)`
`<T extends Turtle> List<T>`	`getOtherTurtles(int inRadius, boolean includeThisPatch, Class<T> turtleType)`
`List<Turtle>`	`getOtherTurtlesWithRole(int inRadius, boolean includeThisPatch, String role)`
`<T extends Turtle> List<T>`	`getOtherTurtlesWithRole(int inRadius, boolean includeThisPatch, String role, Class<T> turtleType)`
`Patch`	`getPatch()`
`Patch`	`getPatchAt(int a, int b)` Get the patch situated at (a,b) units away
`Color`	`getPatchColor()`
`List<Turtle>`	`getPatchOtherTurtles()`
`double`	`getPheroMaxDirection(Pheromone phero)` Gets the direction where there is a maximum of this pheromone
`double`	`getPheroMinDirection(Pheromone phero)` Gets the direction where there is a minimum of this pheromone
`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.
`Collection<Pheromone>`	`getPheromones()`
`int`	`getWorldHeight()`
`int`	`getWorldWidth()`
`double`	`getX()`
`double`	`getY()`
`void`	`giveUpRole(String role)` the turtle will no longer play the specified role
`void`	`home()` Teleports the turtle to the center patch
`void`	`incrementBehaviorCount()`
`boolean`	`isPatchChanged()` Check if this is true and reset the property.
`boolean`	`isPlayingRole(String role)` Tells if the turtle is currently playing this role
`void`	`moveTo(double a, double b)` teleport the turtle to patch (a,b).
`int`	`mySelf()` Deprecated. replaced by `AbstractAgent.hashCode()` return the turtle ID
`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
`void`	`playRole(String role)` one way to identify a kind of turtle: give them a Role in the simulation.
`void`	`randomHeading()`
`void`	`randomHeading(int range)`
`void`	`randomLocation()` Teleports the turtle to a random location
`void`	`setColor(Color c)`
`void`	`setCurrentBehaviorCount(int i)`
`void`	`setHeading(double direction)` set the turtle heading to the value of direction
`void`	`setHeadingTowards(Turtle t)` Set the heading toward the turtle t.
`void`	`setHeadingTowards(Turtle t, double offset)` Set the heading toward the turtle t.
`void`	`setHeadingTowardsNoWrap(Turtle t)`
`void`	`setNextAction(String methodName)`
`void`	`setPatchColor(Color c)`
`void`	`setup()` Deprecated. `activate()` should be overridden instead, beginning by super.activate();
`void`	`setX(double a)`
`void`	`setXY(double a, double b)`
`void`	`setY(double b)`
`float`	`smell(String pheromone)`
`float`	`smellAt(Pheromone pheromone, int xOffset, int yOffset)`
`float`	`smellAt(String pheromoneName, int xOffset, int yOffset)`
`void`	`step()` Shortcut for fd(1)
`String`	`toString()`
`double`	`towards(double a, double b)` returns direction to the patch (a,b).
`double`	`towards(Turtle t)`
`void`	`towardsMaxGradientField(Pheromone p)`
`void`	`towardsMinGradientField(Pheromone p)`
`double`	`towardsNoWrap(double a, double b)`
`double`	`towardsNoWrap(Turtle t)`
`void`	`turnLeft(double a)`
`void`	`turnRight(double a)`
`void`	`wiggle()` shortcut for `wiggle(45)`
`void`	`wiggle(int range)`
`int`	`xcor()`
`int`	`ycor()`

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
  - color
```
protected Color color
```
    The turtle's color. Default is red.
  - generator
```
protected static Random generator
```
    The turtle's PRNG //TODO have a real model
- Constructor Detail
  - Turtle
```
public Turtle(String initMethod)
```
  - Turtle
```
public Turtle()
```
- Method Detail
  - activate
```
protected void activate()
```
    Overrides:
    
    activate in class AbstractAgent
  - playRole
```
public void playRole(String role)
```
    one way to identify a kind of turtle: give them a Role in the simulation.
  - giveUpRole
```
public void giveUpRole(String role)
```
    the turtle will no longer play the specified role
  - getMinDirection
```
public int getMinDirection(Pheromone p)
```
  - getMaxDirection
```
public int getMaxDirection(Pheromone p)
```
  - towardsMinGradientField
```
public void towardsMinGradientField(Pheromone p)
```
  - towardsMaxGradientField
```
public void towardsMaxGradientField(Pheromone p)
```
  - isPlayingRole
```
public boolean isPlayingRole(String role)
```
    Tells if the turtle is currently playing this role
    
    Parameters:
    role -
    
    Returns:
    true if the turtle is playing this role
  - get1DIndex
```
public int get1DIndex()
```
    Returns:
    the absolute index of the turtle's location in a 1D data grid representing a 2D grid of width * height size. Its purpose is to be used on a Pheromone to optimize several calls on its data structure.
  - get1DIndex
```
public int get1DIndex(int x,
             int y)
```
    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 xcor() and ycor() to ensure that this x,y point in inside the environment's boundaries. Its purpose is to be used on a Pheromone
  - getWorldWidth
```
public int getWorldWidth()
```
  - getWorldHeight
```
public int getWorldHeight()
```
  - home
```
public final void home()
```
    Teleports the turtle to the center patch
  - setPatchColor
```
public void setPatchColor(Color c)
```
  - getPatchColor
```
public Color getPatchColor()
```
  - getNextPatch
```
public Patch getNextPatch()
```
    Returns:
    the next patch if fd(1) leads to a different patch, null otherwise
  - getFieldValue
```
public float getFieldValue(Pheromone p)
```
  - randomLocation
```
public void randomLocation()
```
    Teleports the turtle to a random location
  - getPatchAt
```
public Patch getPatchAt(int a,
               int b)
```
    Get the patch situated at (a,b) units away
  - 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
    See Also:
    TKEnvironment.getPheromone(String, int, int)
  - getPheromones
```
public Collection<Pheromone> getPheromones()
```
  - getPheroMinDirection
```
public double getPheroMinDirection(Pheromone phero)
```
    Gets the direction where there is a minimum of this pheromone
    
    Parameters:
    name - the pheromone's name
    
    Returns:
    the direction to take
    See Also:
    TKEnvironment.getPheromone(String, int, int)
  - getPheroMaxDirection
```
public double getPheroMaxDirection(Pheromone phero)
```
    Gets the direction where there is a maximum of this pheromone
    
    Parameters:
    name - the pheromone's name
    
    Returns:
    the direction to take
    See Also:
    TKEnvironment.getPheromone(String, int, int)
  - setNextAction
```
public void setNextAction(String methodName)
```
  - mySelf
```
public int mySelf()
```
    Deprecated. replaced by AbstractAgent.hashCode() return the turtle ID
  - defaultBehavior
```
public String defaultBehavior()
```
  - incrementBehaviorCount
```
public void incrementBehaviorCount()
```
  - setX
```
public void setX(double a)
```
  - setY
```
public void setY(double b)
```
  - setXY
```
public void setXY(double a,
         double b)
```
  - createTurtleHere
```
public int createTurtleHere(Turtle t)
```
    launch a turtle at the creator position (xcor,ycor) and returns the given ID to the new turtle
    
    Parameters:
    t -
    
    Returns:
    the ID given to the turtle
  - 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
  - getID
```
public int getID()
```
    the id of this turtle
    
    Returns:
    the id of this turtle
  - dx
```
public int dx()
```
    return the x-increment if the turtle were to take one step forward in its current heading.
  - dy
```
public int dy()
```
    return the int y-increment if the turtle were to take one step forward in its current heading.
  - setColor
```
public void setColor(Color c)
```
  - getColor
```
public Color getColor()
```
  - smell
```
public float smell(String pheromone)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class AbstractAgent
  - emit
```
protected void emit(String pheromone,
        float value)
```
    Shortcut for getPheromone(pheromone).incValue(xcor(), ycor(), value);
    
    Parameters:
    pheromone - the name of the targeted pheromone
    value - how much to drop
  - xcor
```
public int xcor()
```
    Returns:
    ant int which is the x of the patch
  - ycor
```
public int ycor()
```
    Returns:
    ant int which is the y of the patch
  - wiggle
```
public void wiggle()
```
    shortcut for wiggle(45)
  - wiggle
```
public void wiggle(int range)
```
  - randomHeading
```
public void randomHeading(int range)
```
    Parameters:
    range -
  - turnRight
```
public void turnRight(double a)
```
  - turnLeft
```
public void turnLeft(double a)
```
  - setHeading
```
public void setHeading(double direction)
```
    set the turtle heading to the value of direction
  - fd
```
public void fd(double nb)
```
    Makes turtle moves forward of nb space units
    
    Parameters:
    nb - number of space units
  - step
```
public void step()
```
    Shortcut for fd(1)
  - moveTo
```
public void moveTo(double a,
          double b)
```
    teleport the turtle to patch (a,b). Can be used as a jump primitive: MoveTo(xcor()+10,ycor())
  - isPatchChanged
```
public boolean isPatchChanged()
```
    Check if this is true and reset the property.
    
    Returns:
    true if the last move has changed the patch the turtle is on
  - getPatchOtherTurtles
```
public List<Turtle> getPatchOtherTurtles()
```
  - getOtherTurtles
```
public List<Turtle> getOtherTurtles(int inRadius,
                           boolean includeThisPatch)
```
  - getOtherTurtlesWithRole
```
public List<Turtle> getOtherTurtlesWithRole(int inRadius,
                                   boolean includeThisPatch,
                                   String role)
```
  - getOtherTurtlesWithRole
```
public <T extends Turtle> List<T> getOtherTurtlesWithRole(int inRadius,
                                                 boolean includeThisPatch,
                                                 String role,
                                                 Class<T> turtleType)
```
  - getOtherTurtles
```
public <T extends Turtle> List<T> getOtherTurtles(int inRadius,
                                         boolean includeThisPatch,
                                         Class<T> turtleType)
```
  - getNearestTurtle
```
public Turtle getNearestTurtle(int inRadius)
```
    Returns the nearest turtle from this one within the inRadius-vicinity as a patch distance.
    
    Parameters:
    inRadius -
    
    Returns:
    the corresponding turtle or null there is no turtle around. In case of equality between turtles (same patch distance or same patch), the first found is returned.
  - getNearestTurtle
```
public <T extends Turtle> T getNearestTurtle(int patchRadius,
                                    Class<T> turtleType)
```
    Returns the nearest turtle of type T from this one according to its patch distance.
    
    Parameters:
    patchRadius - the side length of the square of patches to look into
    
    Returns:
    the corresponding turtle or null if there is no turtle of this type around. In case of equality between turtles (same patch distance or same patch), the first found is returned.
  - getNearestTurtleWithRole
```
public <T extends Turtle> T getNearestTurtleWithRole(int patchRadius,
                                            String role,
                                            Class<T> turtleType)
```
    Returns the nearest turtle of type T from this one according to its patch distance.
    
    Parameters:
    patchRadius - the side length of the square of patches to look into
    
    Returns:
    the corresponding turtle or null if there is no turtle of this type around. In case of equality between turtles (same patch distance or same patch), the first found is returned.
  - getNearestTurtleWithRole
```
public Turtle getNearestTurtleWithRole(int patchRadius,
                              String role)
```
    Returns the nearest turtle of type T from this one according to its patch distance.
    
    Parameters:
    patchRadius - the side length of the square of patches to look into
    
    Returns:
    the corresponding turtle or null if there is no turtle of this type around. In case of equality between turtles (same patch distance or same patch), the first found is returned.
  - getNearestTurtle
```
public <T extends Turtle> T getNearestTurtle(double realRadius,
                                    Class<T> turtleType)
```
    Returns the nearest turtle of type T from this one according to its real distance.
    
    Parameters:
    realRadius - the maximum distance of the returned turtle
    turtleType - the type of turtle to seek
    
    Returns:
    the corresponding turtle or null if there is no turtle of this type around. In case of equality between turtles (same patch distance or same patch), the first found is returned.
  - setHeadingTowardsNoWrap
```
public void setHeadingTowardsNoWrap(Turtle t)
```
  - setHeadingTowards
```
public void setHeadingTowards(Turtle t)
```
    Set the heading toward the turtle t. This has no effect if this turtle and t have exactly the same coordinates.
    
    Parameters:
    t - a turtle
  - setHeadingTowards
```
public void setHeadingTowards(Turtle t,
                     double offset)
```
    Set the heading toward the turtle t. This has no effect if this turtle and t have exactly the same coordinates.
    
    Parameters:
    t - a turtle
    offset - the angle to add to the corresponding direction
  - towards
```
public double towards(Turtle t)
```
  - towardsNoWrap
```
public double towardsNoWrap(Turtle t)
```
  - towardsNoWrap
```
public double towardsNoWrap(double a,
                   double b)
```
  - towards
```
public double towards(double a,
             double b)
```
    returns direction to the patch (a,b). If the "wrapped distance", when wrap mode is on, (around the edges of the screen) is shorter than the "onscreen distance," towards will report the direction of the wrapped path, otherwise it while will report the direction of the onscreen path
  - distanceNoWrap
```
public double distanceNoWrap(double xCoordinate,
                    double yCoordinate)
```
    return the "on screen distance" between the turtle and the coordinates (a,b).
    
    Returns:
    a distance as a double
  - distance
```
public double distance(double a,
              double b)
```
    returns the distance from the patch (a,b). The "wrapped distance", when wrap mode is on, (around the edges of the screen) if that distance is shorter than the "onscreen distance."
    
    Parameters:
    a - the a
    b - the b
    
    Returns:
    the distance as a double
  - distance
```
public double distance(Turtle t)
```
  - 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
  - getHeading
```
public double getHeading()
```
    return the current heading of the turtle
  - smellAt
```
public float smellAt(String pheromoneName,
            int xOffset,
            int yOffset)
```
  - smellAt
```
public float smellAt(Pheromone pheromone,
            int xOffset,
            int yOffset)
```
  - getPatch
```
public Patch getPatch()
```
    Returns:
    the patch the turtle is on
  - randomHeading
```
public void randomHeading()
```
  - getCurrentBehaviorCount
```
public int getCurrentBehaviorCount()
```
    When the turtle switches its behavior the value of this counter is 0
    
    Returns:
    returns the number of time the current behavior has been successively activated previously
  - setCurrentBehaviorCount
```
public void setCurrentBehaviorCount(int i)
```
  - executeThisTurtle
```
protected static TurtleKit executeThisTurtle(int nbOfInstances,
                          String... args)
```
    This offers a convenient way to create a main method that launches a simulation containing the turtle class under development. This call only works in the main method of the turtle.
    
    Parameters:
    args - MaDKit or TurtleKit options
    
    Returns:
    Since:
    
    TurtleKit 3.0.0.1
    
    See Also:
    AbstractAgent.executeThisAgent(int, boolean, String...)
  - getEnvironment
```
public TKEnvironment getEnvironment()
```
    Returns:
    the environment
  - getX
```
public double getX()
```
    Returns:
    the x
  - getY
```
public double getY()
```
    Returns:
    the y
  - getCommunity
```
public String getCommunity()
```
    Returns:
    the community
  - setup
```
public void setup()
```
    Deprecated. activate() should be overridden instead, beginning by super.activate();

Class Turtle

Nested Class Summary

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

Field Summary

Fields inherited from class madkit.kernel.AbstractAgent

Constructor Summary

Method Summary

Methods inherited from class madkit.kernel.AbstractAgent

Methods inherited from class java.lang.Object

Field Detail

color

generator

Constructor Detail

Turtle

Turtle

Method Detail

activate

playRole

giveUpRole

getMinDirection

getMaxDirection

towardsMinGradientField

towardsMaxGradientField

isPlayingRole

get1DIndex

get1DIndex

getWorldWidth

getWorldHeight

home

setPatchColor

getPatchColor

getNextPatch

getFieldValue

randomLocation

getPatchAt

getPheromone

getPheromones

getPheroMinDirection

getPheroMaxDirection

setNextAction

mySelf

defaultBehavior

incrementBehaviorCount

setX

setY

setXY

createTurtleHere

createTurtle

createTurtle

getID

dx

dy

setColor

getColor

smell

toString

emit

xcor

ycor

wiggle

wiggle

randomHeading

turnRight

turnLeft

setHeading

fd

step

moveTo

isPatchChanged

getPatchOtherTurtles

getOtherTurtles

getOtherTurtlesWithRole

getOtherTurtlesWithRole

getOtherTurtles

getNearestTurtle

getNearestTurtle

getNearestTurtleWithRole

getNearestTurtleWithRole

getNearestTurtle

setHeadingTowardsNoWrap