Turtle

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.primordion.xholon.base
Class Turtle

java.lang.Object
  org.primordion.xholon.base.Xholon
      org.primordion.xholon.base.XholonWithPorts
          org.primordion.xholon.base.Turtle

All Implemented Interfaces:: ITurtle, IXholon

Direct Known Subclasses:: BugStupidModel16nl, TurtleExample1, WolfSheep

public class Turtle
extends XholonWithPorts
implements ITurtle

A turtle is an agent in the turtle mechanism. The turtle mechanism is based on Logo and NetLogo. The abbreviated version of a turtle command (ex: fd bk rt lt) should be used instead of the unabbreviated command.

Since:: 0.5 (Created on February 24, 2007)
Author:: Ken Webb
See Also:: NetLogo website http://ccl.northwestern.edu/netlogo/

Field Summary
`int`	`color`
`double`	`heading`
`boolean`	`isHidden`
`int`	`penMode`
`double`	`xcor`
`double`	`ycor`

Fields inherited from class org.primordion.xholon.base.XholonWithPorts

port

Fields inherited from class org.primordion.xholon.base.Xholon

DEFAULT_LEVEL, interaction, interactionsEnabled

Fields inherited from interface org.primordion.xholon.base.ITurtle

COMMANDID_NONE, FILTERID_NONE, PENMODE_DOWN, PENMODE_ERASE, PENMODE_UP, WHENMOVED_INIT

Fields inherited from interface org.primordion.xholon.base.IXholon

DEFAULT_SIZE_MSG_Q, NINCLUDE_PSC, NINCLUDE_PSx, NINCLUDE_PxC, NINCLUDE_Pxx, NINCLUDE_xSC, NINCLUDE_xSx, NINCLUDE_xxC, NINCLUDE_xxx

Constructor Summary
`Turtle()`

Method Summary
`void`	`aggregate(double amount)` Aggregate by keeping a count of the number of individuals of a given "breed".
`void`	`back(double distance)` Move back a given distance.
`void`	`beep()` Make a single short beep sound.
`void`	`bk(double distance)` Move back a given distance.
`boolean`	`canMove(double distance)` Can this turtle legally move the specified distance, given its current heading?
`void`	`die()` Remove yourself permanently from the gene pool.
`double`	`distance(IXholon turtleOrPatch)` Return the distance between self and the specified turtle or patch.
`double`	`distancexy(double x, double y)` Return the distance between yourself and the specified x, y coordinates.
`double`	`downhill()` "Return the turtle heading in the direction of the minimum value of the variable patch-variable, of the patches in a one-patch radius of the turtle."
`double`	`downhill4()` "Return the turtle heading in the direction of the minimum value of the variable patch-variable, of the patches in a one-patch radius of the turtle."
`double`	`dx()` Returns the delta in the x direction if the turtle moved one unit along its current heading.
`double`	`dy()` Returns the delta in the y direction if the turtle moved one unit along its current heading.
`void`	`face(IXholon turtleOrPatch)` Turn to face the specified turtle or patch.
`void`	`facexy(double x, double y)` Turn to face the specified x, y coordinates.
`void`	`fd(double distance)` Move forward a given distance.
`void`	`forward(double distance)` Move forward a given distance.
`int`	`getBreed()` Get the turtle's breed id.
`int`	`getColor()` Get the turtle's color.
`double`	`getHeading()` Get the turtle's heading.
`boolean`	`getIsHidden()` Get the turtle's hide status.
`java.lang.String`	`getLabel()` Get the turtle's label, a String that helps to identify it.
`int`	`getMaxPxcor()` Return the maximum Patch x coordinate.
`int`	`getMaxPycor()` Return the maximum Patch y coordinate.
`int`	`getMinPxcor()` Return the minimum Patch x coordinate.
`int`	`getMinPycor()` Return the minimum Patch y coordinate.
`int`	`getPcolor()` Get the patch's pcolor.
`int`	`getPenMode()` Get the turtle's pen mode.
`java.lang.String`	`getPlabel()` Get the patch's label, a String that helps to identify it.
`int`	`getPxcor()` Get the patch's x coordinate.
`int`	`getPycor()` Get the patch's y coordinate.
`int`	`getWho()` Get the turtle's who id.
`int`	`getWorldHeight()` Return the height of the world (the grid height).
`int`	`getWorldWidth()` Return the width of the world (the grid width).
`double`	`getXcor()` Get the turtle's x coordinate.
`double`	`getYcor()` Get the turtle's y coordinate.
`boolean`	`hasAlreadyMoved()` Has this turtle already moved this time step? This method is required to prevent turtles from moving multiple times in the same time step, which would happen when a turtle moves to a patch that hasn't yet been reached in the tree traversal this time step.
`void`	`hatch(int numTurtles, int commandId)` Hatch a specified number of new turtles, each identical to this turtle.
`void`	`hideTurtle()` Hide from view.
`void`	`home()` Go home, by returning to the home coordinates.
`void`	`ht()` Hide from view.
`java.util.Vector`	`inCone(double distance, double angle)` Return agents that fall within a cone defined by the distance and angle .
`void`	`initWhenMoved(int when)` Initialize the whenMoved variable.
`java.util.Vector`	`inRadius(int radius)` Return a list of all neighbors (turtles) within the specified radius.
`java.util.Vector`	`inRadius(int radius, int filterId)` Return a list of all neighbors (turtles) within the specified radius.
`void`	`jump(double distance)` Jump forward a given distance, without effecting any intervening patches or turtles.
`void`	`jump(IPatch aPatch)` Jump directly to the specified patch.
`void`	`jump(ITurtle aTurtle)` Jump directly to the patch that the specified turtle is currently in.
`void`	`left(double angle)` Turn left a given angle.
`IXholon`	`lineBresenham(int x0, int y0, int x1, int y1, int colr)` Draw a line using the Bresenham algorithm.
`void`	`lt(double angle)` Turn left a given angle.
`java.util.Vector`	`neighbors()` Return the 8 surrounding neighbor patches.
`java.util.Vector`	`neighbors4()` Return the 4 surrounding neighbor patches.
`java.util.Vector`	`otherTurtlesHere()` Return all other turtles that are also currently located at this turtle's patch.
`IPatch`	`patchAhead(double distance)` Return the single patch that is the given distance along the turtle's current heading.
`IPatch`	`patchAt(int dx, int dy)` Return the single patch at the specified x and y relative distance.
`IPatch`	`patchAtHeadingAndDistance(double heading, double distance)` Return the single patch at the specified absolute heading and relative distance.
`IPatch`	`patchHere()` Return the patch that the turtle is currently on.
`IPatch`	`patchLeftAndAhead(double distance, double angle)` Return the single patch that is the given distance from the turtle, in the direction turned left the given angle from the turtle's current heading.
`IPatch`	`patchRightAndAhead(double distance, double angle)` Return the single patch that is the given distance from the turtle, in the direction turned right the given angle from the turtle's current heading.
`void`	`pd()` Set the pen down, so it is able to draw.
`void`	`pe()` Set the pen to erase.
`void`	`penDown()` Set the pen down, so it is able to draw.
`void`	`penErase()` Set the pen to erase.
`void`	`penUp()` Set the pen up, so it is unable to draw.
`void`	`pu()` Set the pen up, so it is unable to draw.
`void`	`right(double angle)` Turn right a given angle.
`void`	`rt(double angle)` Turn right a given angle.
`void`	`setBreed(int breed)` Set or change the turtle's breed id.
`void`	`setColor(int color)` Set the turtle's color.
`void`	`setHeading(double heading)` Set the turtle's heading.
`void`	`setIsHidden(boolean isHidden)` Set the turtle's hide status.
`void`	`setLabel(java.lang.String label)` Set or change the turtle's label.
`void`	`setPcolor(int pcolor)` Set the patch's pcolor.
`void`	`setPenMode(int penMode)` Set the turtle's pen mode.
`void`	`setPlabel(java.lang.String plabel)` Set or change the patch's label.
`void`	`setPxcor(int pxcor)` Set the patch's x coordinate.
`void`	`setPycor(int pycor)` Set the patch's y coordinate.
`void`	`setWho(int who)` Set the turtle's who id.
`void`	`setXcor(double xcor)` Set the turtle's x coordinate.
`void`	`setxy(double x, double y)` Set the turtle's x and y coordinates, and move to that location.
`void`	`setYcor(double ycor)` Set the turtle's y coordinate.
`void`	`showTurtle()` Show in the viewer.
`void`	`st()` Show in the viewer.
`void`	`stamp()` Leave an inprint or stamp of self at the current patch.
`void`	`stampErase()` Erase any inprint or stamp at the current patch.
`java.lang.String`	`toString()`
`double`	`towards(IXholon turtleOrPatch)` Return the heading between self and the specified turtle or patch.
`double`	`towardsxy(double x, double y)` Return the heading between self and the specified x, y coordinates.
`java.util.Vector`	`turtlesAt(int dx, int dy)` Return the turtles located at the single patch at the specified x and y relative distance.
`java.util.Vector`	`turtlesHere()` Return the turtles located at the current patch.
`java.util.Vector`	`turtlesOn()` Return the turtles that are on the given patch or patches, or standing on the same patch as the given turtle or turtles.
`double`	`uphill()` "Return the turtle heading in the direction of the maximum value of the variable patch-variable, of the patches in a one-patch radius of the turtle."
`double`	`uphill4()` "Return the turtle heading in the direction of the maximum value of the variable patch-variable, of the patches in a one-patch radius of the turtle."
`java.util.Vector`	`with(java.util.Vector vIn, int filterId)` Filters the input vector to produce an output vector.

Methods inherited from class org.primordion.xholon.base.XholonWithPorts

configure, getMaxPorts, getPort, initialize, isActiveObject, isBound, isContainer, isPassiveObject, postConfigure, setMaxPorts, setPorts, terminate

Methods inherited from class org.primordion.xholon.base.Xholon

act, appendChild, appendChild, appendChild, cleanup, configure, createStructure, decVal, decVal, depth, draw, getChildNodes, getFirstChild, getFirstSibling, getId, getLastChild, getLastSibling, getName, getNeighbors, getNextId, getNextSibling, getNthChild, getNthSibling, getNumChildren, getNumSiblings, getParentNode, getPreviousSibling, getRoleName, getRootNode, getSiblings, getSizeMessageQ, getUid, getVal_boolean, getVal_byte, getVal_char, getVal_double, getVal_float, getVal_int, getVal_long, getVal_Object, getVal_short, getVal_String, getVal, getXhc, getXhcId, getXhcName, getXhType, handleNodeSelection, hasAncestor, hasChildNodes, hasChildOrSiblingNodes, hasNextSibling, hasParentNode, height, incVal, incVal, initStatics, inOrderPrint, insertAfter, insertBefore, insertFirstChild, isExternal, isInternal, isLeaf, isRootNode, performActivity, performActivity, performBooleanActivity, performBooleanActivity, performDoubleActivity, performGuard, performVoidActivity, postAct, postOrderPrint, postReconfigure, preAct, preConfigure, preOrderPrint, preReconfigure, print, println, processMessageQ, processReceivedMessage, reconfigure, remove, removeChild, resetNextId, sendMessage, sendMessage, sendMessage, setAttributeVal, setFactory, setFirstChild, setId, setNextSibling, setParentChildLinks, setParentNode, setParentSiblingLinks, setRoleName, setSizeMessageQ, setUid, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVariableValue, setXhc, swapNode, treeSize, writeXml

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.primordion.xholon.base.IXholon

act, appendChild, appendChild, appendChild, cleanup, configure, configure, createStructure, decVal, decVal, depth, draw, getChildNodes, getFirstChild, getFirstSibling, getId, getLastChild, getLastSibling, getName, getNeighbors, getNextSibling, getNthChild, getNthSibling, getNumChildren, getNumSiblings, getParentNode, getPort, getPreviousSibling, getRoleName, getRootNode, getSiblings, getUid, getVal_boolean, getVal_byte, getVal_char, getVal_double, getVal_float, getVal_int, getVal_long, getVal_Object, getVal_short, getVal_String, getVal, getXhc, getXhcId, getXhcName, getXhType, handleNodeSelection, hasAncestor, hasChildNodes, hasChildOrSiblingNodes, hasNextSibling, hasParentNode, height, incVal, incVal, initialize, initStatics, inOrderPrint, insertAfter, insertBefore, insertFirstChild, isActiveObject, isBound, isContainer, isExternal, isInternal, isLeaf, isPassiveObject, isRootNode, performActivity, performActivity, performBooleanActivity, performBooleanActivity, performDoubleActivity, performGuard, performVoidActivity, postAct, postConfigure, postOrderPrint, postReconfigure, preAct, preConfigure, preOrderPrint, preReconfigure, print, println, processMessageQ, processReceivedMessage, reconfigure, remove, removeChild, sendMessage, sendMessage, sendMessage, setAttributeVal, setFirstChild, setId, setNextSibling, setParentChildLinks, setParentNode, setParentSiblingLinks, setPorts, setRoleName, setUid, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVariableValue, setXhc, swapNode, terminate, treeSize, writeXml

Field Detail

color

public int color

heading

public double heading

isHidden

public boolean isHidden

penMode

public int penMode

xcor

public double xcor

ycor

public double ycor

Constructor Detail

Turtle

public Turtle()

Method Detail