Patch (API V2.11)

repast.simphony.relogo.ReLogoAgent

All Superinterfaces:

ReLogoAgent

ReLogo Patch interface.
Authors:
jozik

Properties Summary

Properties
Type	Name and description
`double`	`pcolor`
`Object`	`plabel`
`double`	`plabelColor`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`AgentSet<Link>`	`allLinks()` Returns the agentset of all links.
	`boolean`	`allQ(Collection a, Closure closure)` Queries if all agents in a collection are true for a boolean closure.
	`void`	`ask(AgentSet<? extends ReLogoAgent> a, Closure askBlock)` Executes a set of commands for an agentset in random order.
	`void`	`ask(Collection<? extends ReLogoAgent> c, Closure askBlock)` Executes a set of commands for a collection of agents.
	`void`	`ask(Turtle t, Closure askBlock)` Executes a set of commands for a turtle.
	`void`	`ask(Patch p, Closure askBlock)` Executes a set of commands for a patch.
	`void`	`ask(Link l, Closure askBlock)` Executes a set of commands for a link.
	`void`	`askPatch(Closure cl)` @exclude
	`double`	`distance(Turtle t)` Returns the distance from the caller to a turtle.
	`double`	`distance(Patch p)` Returns the distance from the caller to a patch.
	`double`	`distancexy(Number nx, Number ny)` Returns the distance from the caller to a point.
	`void`	`fileShow(Object value)` Prints value with agent identifier to current file with a newline.
	`GridPoint`	`getGridLocation()`
	`NdPoint`	`getGridLocationAsNdPoint()`
	`int`	`getMaxPxcor()` Returns the maximum x coordinate for all patches.
	`int`	`getMaxPycor()` Returns the maximum y coordinate for all patches.
	`int`	`getMinPxcor()` Returns the minimum x coordinate for all patches.
	`int`	`getMinPycor()` Returns the minimum y coordinate for all patches.
	`double`	`getPcolor()` Returns the color of a patch.
	`Object`	`getPlabel()` Returns the patch label.
	`double`	`getPlabelColor()` Returns the patch label color.
	`int`	`getPxcor()` Returns the x coordinate of patch.
	`int`	`getPycor()` Returns the y coordinate of patch.
	`List`	`getRowCol()`
	`AgentSet`	`inRadius(Collection a, Number num)` Returns an agentset within a distance of the caller.
	`Link`	`link(Number oneEnd, Number otherEnd)` Returns the link between two turtles.
	`Link`	`link(Turtle oneEnd, Turtle otherEnd)` Returns the link between two turtles.
	`AgentSet<Link>`	`links()` Returns the agentset of all generic links.
	`AgentSet`	`maxNOf(int number, Collection<? extends ReLogoAgent> a, Closure closure)` Returns an agentset consisting of a specified number of agents which have the greatest value when operated on by a set of commands.
	`ReLogoAgent`	`maxOneOf(Collection<? extends ReLogoAgent> a, Closure closure)` Returns the ReLogoAgent with the largest value when operated on by a set of commands.
	`AgentSet`	`minNOf(int number, Collection<? extends ReLogoAgent> a, Closure closure)` Returns an agentset consisting of a specified number of agents which have the lowest value when operated on by a set of commands.
	`ReLogoAgent`	`minOneOf(Collection<? extends ReLogoAgent> a, Closure closure)` Returns the ReLogoAgent with the smallest value when operated on by a set of commands.
	`Object`	`myself()` The agent that initiated the asking.
	`AgentSet<Patch>`	`neighbors()` Returns the agentset of the eight neighboring patches (Moore neighborhood).
	`AgentSet<Patch>`	`neighbors(int extent)` Returns the agentset of patches making up the Moore neighborhood of this patch (excluding the calling patch) of extent.
	`AgentSet<Patch>`	`neighbors(int extentX, int extentY)` Returns the agentset of patches making up the Moore neighborhood of this patch (excluding the calling patch) of extents.
	`AgentSet<Patch>`	`neighbors4()` Returns the agentset of the four neighboring patches (von Neumann neighborhood).
	`AgentSet<Patch>`	`neighbors4(int extent)` Returns the agentset of patches making up the von Neumann neighborhood of this patch (excluding the calling patch) of extent.
	`AgentSet<Patch>`	`neighbors4(int extentX, int extentY)` Returns the agentset of patches making up the von Neumann neighborhood of this patch (excluding the calling patch) of extents.
	`Stop`	`oldStop()` Stops a patch executing within a command closure.
	`AgentSet`	`other(Collection a)` Returns an agentset minus the caller.
	`Patch`	`patch(Number nX, Number nY)` Returns the patch containing a point.
	`Patch`	`patchAt(Number ndx, Number ndy)` Returns the patch at a direction (ndx, ndy) from the caller.
	`Patch`	`patchAtHeadingAndDistance(Number heading, Number distance)` Returns the patch that is at a direction and distance from the caller.
	`AgentSet<Patch>`	`patches()` Returns an agentset containing all patches.
	`int`	`randomPxcor()` Returns a random x coordinate for patches.
	`int`	`randomPycor()` Returns a random y coordinate for patches.
	`double`	`randomXcor()` Returns a random x coordinate for turtles.
	`double`	`randomYcor()` Returns a random y coordinate for turtles.
	`void`	`run(String string)` Interprets a string as commands then runs the commands.
	`Object`	`runresult(String string)` Interprets a string as a command then returns the result.
	`Patch`	`self()` Returns this turtle, patch, or link.
	`void`	`setPcolor(double pcolor)` Sets the color of a patch to pcolor.
	`void`	`setPlabel(Object plabel)` Sets the patch label.
	`void`	`setPlabelColor(Number plabelColor)` Sets the patch label color.
	`void`	`setToDefault()` Sets the standard patch variables to their default values.
	`void`	`show(Object value)` Prints value with agent identifier to the console.
	`AgentSet<Turtle>`	`sprout(Number number)` Makes a number of random new turtles.
	`AgentSet<Turtle>`	`sprout(Number number, Closure closure)` Makes a number of random new turtles then executes a set of commands on the created turtles.
	`AgentSet<Turtle>`	`sprout(Number number, Closure closure, String turtleType)` Makes a number of random new turtles of a specific type then executes a set of commands on the created turtles.
	`AgentSet<Turtle>`	`sprout(Number number, Closure closure, Class turtleType)` Makes a number of random new turtles of a specific type then executes a set of commands on the created turtles.
	`String`	`toString()`
	`Turtle`	`turtle(Number number)` Returns the turtle of the given number.
	`AgentSet<Turtle>`	`turtles()` Returns an agentset containing all turtles.
	`AgentSet<Turtle>`	`turtlesAt(Number ndx, Number ndy)` Returns the agentset on the patch at the direction (ndx, ndy) from the caller.
	`AgentSet<Turtle>`	`turtlesHere()` Returns an agentset of turtles from the patch of the caller.
	`AgentSet<Turtle>`	`turtlesOn(Patch p)` Returns an agentset of turtles on a given patch.
	`AgentSet<Turtle>`	`turtlesOn(Turtle t)` Returns an agentset of turtles on the same patch as a turtle.
	`AgentSet<Turtle>`	`turtlesOn(Collection a)` Returns an agentset of turtles on the patches in a collection or on the patches that a collection of turtles are.
	`void`	`watchMe()` Does nothing, included for translation compatibility.
	`int`	`worldHeight()` Returns the height of the world.
	`int`	`worldWidth()` Returns the width of the world.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`interface Comparable`	`compareTo`
`interface ReLogoAgent`	`setMyself`

- Property Detail
  - double pcolor
  - Object plabel
  - double plabelColor
- Method Detail
  - public AgentSet<Link> allLinks()
    
    Returns the agentset of all links.
    Returns:
    agentset of all links
  - public boolean allQ(Collection a, Closure closure)
    
    Queries if all agents in a collection are true for a boolean closure.
    Parameters:
    a - a collection of ReLogoAgents
    closure - a boolean closure
    Returns:
    true or false based on whether all agents in a collection are true for closure
  - public void ask(AgentSet<? extends ReLogoAgent> a, Closure askBlock)
    
    Executes a set of commands for an agentset in random order.
    Parameters:
    a - an agentset
    askBlock - a set of commands
  - public void ask(Collection<? extends ReLogoAgent> c, Closure askBlock)
    
    Executes a set of commands for a collection of agents.
    Parameters:
    c - a collection of agents
    askBlock - a set of commands
  - public void ask(Turtle t, Closure askBlock)
    
    Executes a set of commands for a turtle.
    Parameters:
    t - a turtle
    askBlock - a set of commands
  - public void ask(Patch p, Closure askBlock)
    
    Executes a set of commands for a patch.
    Parameters:
    p - a patch
    askBlock - a set of commands
  - public void ask(Link l, Closure askBlock)
    
    Executes a set of commands for a link.
    Parameters:
    l - a link
    askBlock - a set of commands
  - public void askPatch(Closure cl)
    
    exclude:
  - public double distance(Turtle t)
    
    Returns the distance from the caller to a turtle.
    returns:
    distance from turtle t to the caller
    
    Parameters:
    t - a turtle
  - public double distance(Patch p)
    
    Returns the distance from the caller to a patch.
    returns:
    distance from patch p to the caller
    
    Parameters:
    p - a patch
  - public double distancexy(Number nx, Number ny)
    
    Returns the distance from the caller to a point.
    returns:
    distance from the caller to the point (nx,ny)
    
    Parameters:
    nx - a number
    ny - a number
  - public void fileShow(Object value)
    
    Prints value with agent identifier to current file with a newline.
    Parameters:
    value - any object
  - public GridPoint getGridLocation()
  - public NdPoint getGridLocationAsNdPoint()
  - public int getMaxPxcor()
    
    Returns the maximum x coordinate for all patches.
    Returns:
    maximum x coordinate for all patches
  - public int getMaxPycor()
    
    Returns the maximum y coordinate for all patches.
    Returns:
    maximum y coordinate for all patches
  - public int getMinPxcor()
    
    Returns the minimum x coordinate for all patches.
    Returns:
    maximum x coordinate for patches
  - public int getMinPycor()
    
    Returns the minimum y coordinate for all patches.
    Returns:
    maximum y coordinate for patches
  - public double getPcolor()
    
    Returns the color of a patch.
    Returns:
    color of a patch in the range [0, 140)
  - public Object getPlabel()
    
    Returns the patch label.
    Returns:
    the patch label
  - public double getPlabelColor()
    
    Returns the patch label color.
    Returns:
    the patch label color
  - public int getPxcor()
    
    Returns the x coordinate of patch.
    Returns:
    x coordinate of patch
  - public int getPycor()
    
    Returns the y coordinate of patch.
    Returns:
    y coordinate of patch
  - public List getRowCol()
  - public AgentSet inRadius(Collection a, Number num)
    
    Returns an agentset within a distance of the caller.
    Parameters:
    c - a collection of agents
    num - a distance
    Returns:
    agentset subset of collection a within a distance num of the caller
  - public Link link(Number oneEnd, Number otherEnd)
    
    Returns the link between two turtles.
    Parameters:
    oneEnd - an integer
    otherEnd - an integer
    Returns:
    link between two turtles
  - public Link link(Turtle oneEnd, Turtle otherEnd)
    
    Returns the link between two turtles.
    Parameters:
    oneEnd - a turtle
    otherEnd - a turtle
    Returns:
    link between two turtles
  - public AgentSet<Link> links()
    
    Returns the agentset of all generic links.
    Returns:
    agentset of all links
  - public AgentSet maxNOf(int number, Collection<? extends ReLogoAgent> a, Closure closure)
    
    Returns an agentset consisting of a specified number of agents which have the greatest value when operated on by a set of commands.
    Parameters:
    number - an integer
    a - a collection
    closure - a set of commands
    Returns:
    agentset containing number agents with largest values when operated on by closure
  - public ReLogoAgent maxOneOf(Collection<? extends ReLogoAgent> a, Closure closure)
    
    Returns the ReLogoAgent with the largest value when operated on by a set of commands.
    Parameters:
    a - a collection
    closure - a set of commands
    Returns:
    ReLogoAgent with the largest value when operated on by closure
  - public AgentSet minNOf(int number, Collection<? extends ReLogoAgent> a, Closure closure)
    
    Returns an agentset consisting of a specified number of agents which have the lowest value when operated on by a set of commands.
    Parameters:
    number - an integer
    a - a collection
    closure - a set of commands
    Returns:
    agentset containing number agents with smallest values when operated on by closure
  - public ReLogoAgent minOneOf(Collection<? extends ReLogoAgent> a, Closure closure)
    
    Returns the ReLogoAgent with the smallest value when operated on by a set of commands.
    Parameters:
    a - a collection
    closure - a set of commands
    Returns:
    ReLogoAgent with the smallest value when operated on by closure
  - public Object myself()
    
    The agent that initiated the asking.
    Returns:
    the agent that initiated the asking
  - public AgentSet<Patch> neighbors()
    
    Returns the agentset of the eight neighboring patches (Moore neighborhood).
    Returns:
    agentset of the eight neighboring patches
  - public AgentSet<Patch> neighbors(int extent)
    
    Returns the agentset of patches making up the Moore neighborhood of this patch (excluding the calling patch) of extent.
    Parameters:
    extent - the x and y Moore extents
    Returns:
    Moore agentset of patches with extent
  - public AgentSet<Patch> neighbors(int extentX, int extentY)
    
    Returns the agentset of patches making up the Moore neighborhood of this patch (excluding the calling patch) of extents.
    Parameters:
    extentX - the x Moore extent
    extentY - the y Moore extent
    Returns:
    Moore agentset of patches with extents
  - public AgentSet<Patch> neighbors4()
    
    Returns the agentset of the four neighboring patches (von Neumann neighborhood).
    Returns:
    agentset of the four neighboring patches
  - public AgentSet<Patch> neighbors4(int extent)
    
    Returns the agentset of patches making up the von Neumann neighborhood of this patch (excluding the calling patch) of extent.
    Parameters:
    extent - the x and y von Neumann extents
    Returns:
    von Neumann agentset of patches with extent
  - public AgentSet<Patch> neighbors4(int extentX, int extentY)
    
    Returns the agentset of patches making up the von Neumann neighborhood of this patch (excluding the calling patch) of extents.
    Parameters:
    extentX - the x von Neumann extent
    extentY - the y von Neumann extent
    Returns:
    von Neumann agentset of patches with extents
  - @Deprecatedated public public Stop oldStop()
    
    Stops a patch executing within a command closure.
    deprecated:
    use the Utility.stop method instead.
  - public AgentSet other(Collection a)
    
    Returns an agentset minus the caller.
    Parameters:
    a - an agentset
    Returns:
    agentset a minus the caller
  - public Patch patch(Number nX, Number nY)
    
    Returns the patch containing a point.
    Parameters:
    nX - x coordinate
    nY - y coordinate
    Returns:
    patch that contains the point (nX, nY)
  - public Patch patchAt(Number ndx, Number ndy)
    
    Returns the patch at a direction (ndx, ndy) from the caller.
    Parameters:
    ndx - a number
    ndy - a number
    Returns:
    patch at a direction (ndx, ndy) from the caller
  - public Patch patchAtHeadingAndDistance(Number heading, Number distance)
    
    Returns the patch that is at a direction and distance from the caller.
    Parameters:
    heading - a number
    distance - a number
    Returns:
    patch that is at heading and distance from the caller
  - public AgentSet<Patch> patches()
    
    Returns an agentset containing all patches.
    Returns:
    agentset containing all patches
  - public int randomPxcor()
    
    Returns a random x coordinate for patches.
    Returns:
    random x coordinate for patches
  - public int randomPycor()
    
    Returns a random y coordinate for patches.
    Returns:
    random y coordinate for patches
  - public double randomXcor()
    
    Returns a random x coordinate for turtles.
    Returns:
    random x coordinate for turtles
  - public double randomYcor()
    
    Returns a random y coordinate for turtles.
    Returns:
    random y coordinate for turtles
  - public void run(String string)
    
    Interprets a string as commands then runs the commands.
    Parameters:
    string - a string
  - public Object runresult(String string)
    
    Interprets a string as a command then returns the result.
    Parameters:
    string - a string
    Returns:
    result of interpreting string
  - public Patch self()
    
    Returns this turtle, patch, or link.
    Returns:
    this turtle, patch, or link.
  - public void setPcolor(double pcolor)
    
    Sets the color of a patch to pcolor.
    Parameters:
    pcolor - a number in range [0,140)
  - public void setPlabel(Object plabel)
    
    Sets the patch label.
    Parameters:
    plabel - a label
  - public void setPlabelColor(Number plabelColor)
    
    Sets the patch label color.
    Parameters:
    plabelColor - a numerical color
  - public void setToDefault()
    
    Sets the standard patch variables to their default values. Called by clearPatches() and cp(). Override and call super.setToDefault() to reset other variables.
  - public void show(Object value)
    
    Prints value with agent identifier to the console.
    Parameters:
    value - any object
  - public AgentSet<Turtle> sprout(Number number)
    
    Makes a number of random new turtles.
    Parameters:
    number - a number
    Returns:
    created turtles
  - public AgentSet<Turtle> sprout(Number number, Closure closure)
    
    Makes a number of random new turtles then executes a set of commands on the created turtles.
    Parameters:
    number - a number
    closure - a set of commands
    Returns:
    created turtles
  - public AgentSet<Turtle> sprout(Number number, Closure closure, String turtleType)
    
    Makes a number of random new turtles of a specific type then executes a set of commands on the created turtles.
    Parameters:
    number - a number
    closure - a set of commands
    turtleType - a turtle type
    Returns:
    created turtles
  - public AgentSet<Turtle> sprout(Number number, Closure closure, Class turtleType)
    
    Makes a number of random new turtles of a specific type then executes a set of commands on the created turtles.
    Parameters:
    number - a number
    closure - a set of commands
    turtleType - a turtle class
    Returns:
    created turtles
  - public String toString()
  - public Turtle turtle(Number number)
    
    Returns the turtle of the given number.
    Parameters:
    number - a number
    Returns:
    turtle number
  - public AgentSet<Turtle> turtles()
    
    Returns an agentset containing all turtles.
    Returns:
    agentset of all turtles
  - public AgentSet<Turtle> turtlesAt(Number ndx, Number ndy)
    
    Returns the agentset on the patch at the direction (ndx, ndy) from the caller.
    returns:
    agentset at the direction (ndx, ndy) from the caller
    
    Parameters:
    ndx - a number
    ndy - a number
  - public AgentSet<Turtle> turtlesHere()
    
    Returns an agentset of turtles from the patch of the caller.
    Returns:
    agentset of turtles from the caller's patch
  - public AgentSet<Turtle> turtlesOn(Patch p)
    
    Returns an agentset of turtles on a given patch.
    Parameters:
    p - a patch
    Returns:
    agentset of turtles on patch p
  - public AgentSet<Turtle> turtlesOn(Turtle t)
    
    Returns an agentset of turtles on the same patch as a turtle.
    Parameters:
    t - a turtle
    Returns:
    agentset of turtles on the same patch at turtle t
  - public AgentSet<Turtle> turtlesOn(Collection a)
    
    Returns an agentset of turtles on the patches in a collection or on the patches that a collection of turtles are.
    Parameters:
    a - a collection
    Returns:
    agentset of turtles on the patches in collection a or on the patches that collection a turtles are
  - public void watchMe()
    
    Does nothing, included for translation compatibility.
  - public int worldHeight()
    
    Returns the height of the world.
    Returns:
    height of the world
  - public int worldWidth()
    
    Returns the width of the world.
    Returns:
    width of the world

Summary:
Property
Method

| Detail:
Property
Method

ReLogo API V2.11

[Java] Interface Patch

Properties Summary

Methods Summary

Inherited Methods Summary

Property Detail

double pcolor

Object plabel

double plabelColor

Method Detail

public AgentSet<Link> allLinks()

public boolean allQ(Collection a, Closure closure)

public void ask(AgentSet<? extends ReLogoAgent> a, Closure askBlock)

public void ask(Collection<? extends ReLogoAgent> c, Closure askBlock)

public void ask(Turtle t, Closure askBlock)

public void ask(Patch p, Closure askBlock)

public void ask(Link l, Closure askBlock)

public void askPatch(Closure cl)

public double distance(Turtle t)

public double distance(Patch p)

public double distancexy(Number nx, Number ny)

public void fileShow(Object value)

public GridPoint getGridLocation()

public NdPoint getGridLocationAsNdPoint()

public int getMaxPxcor()

public int getMaxPycor()

public int getMinPxcor()

public int getMinPycor()

public double getPcolor()

public Object getPlabel()

public double getPlabelColor()

public int getPxcor()

public int getPycor()

public List getRowCol()

public AgentSet inRadius(Collection a, Number num)

public Link link(Number oneEnd, Number otherEnd)

public Link link(Turtle oneEnd, Turtle otherEnd)

public AgentSet<Link> links()

public AgentSet maxNOf(int number, Collection<? extends ReLogoAgent> a, Closure closure)

public ReLogoAgent maxOneOf(Collection<? extends ReLogoAgent> a, Closure closure)

public AgentSet minNOf(int number, Collection<? extends ReLogoAgent> a, Closure closure)

public ReLogoAgent minOneOf(Collection<? extends ReLogoAgent> a, Closure closure)

public Object myself()

public AgentSet<Patch> neighbors()

public AgentSet<Patch> neighbors(int extent)

public AgentSet<Patch> neighbors(int extentX, int extentY)

public AgentSet<Patch> neighbors4()

public AgentSet<Patch> neighbors4(int extent)

public AgentSet<Patch> neighbors4(int extentX, int extentY)

@Deprecatedated public public Stop oldStop()

public AgentSet other(Collection a)

public Patch patch(Number nX, Number nY)

public Patch patchAt(Number ndx, Number ndy)

public Patch patchAtHeadingAndDistance(Number heading, Number distance)

public AgentSet<Patch> patches()

public int randomPxcor()

public int randomPycor()

public double randomXcor()

public double randomYcor()

public void run(String string)

public Object runresult(String string)

public Patch self()

public void setPcolor(double pcolor)

public void setPlabel(Object plabel)

public void setPlabelColor(Number plabelColor)

public void setToDefault()

public void show(Object value)

public AgentSet<Turtle> sprout(Number number)

public AgentSet<Turtle> sprout(Number number, Closure closure)

public AgentSet<Turtle> sprout(Number number, Closure closure, String turtleType)

public AgentSet<Turtle> sprout(Number number, Closure closure, Class turtleType)

public String toString()

public Turtle turtle(Number number)

public AgentSet<Turtle> turtles()

public AgentSet<Turtle> turtlesAt(Number ndx, Number ndy)

public AgentSet<Turtle> turtlesHere()

public AgentSet<Turtle> turtlesOn(Patch p)

public AgentSet<Turtle> turtlesOn(Turtle t)

public AgentSet<Turtle> turtlesOn(Collection a)

public void watchMe()

public int worldHeight()