Link (API V2.11)

repast.simphony.relogo.Link

All Implemented Interfaces and Traits:

Comparable, ReLogoAgent
```
public abstract class Link
extends RepastEdge
```
ReLogo Link abstract class.
Authors:
jozik
Parameters:

Inherited fields
Fields inherited from class	Fields
`class RepastEdge`	`directed, source, target`

Properties Summary

Properties
Type	Name and description
`Number`	`color`
`T`	`end1`
`T`	`end2`
`boolean`	`hiddenQ`
`double`	`labelColor`

Constructor Summary

Constructors
Constructor and description
`protected Link ()`

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`	`askLink(Closure cl)`
	`AgentSet<Turtle>`	`bothEnds()` Returns two agents connected by link.
	`void`	`die()` Removes the link.
	`void`	`fileShow(Object value)` Prints value with agent identifier to current file with a newline.
	`void`	`free()` Joins together two ends of a link and ties the movements of the ends, except for headings.
	`double`	`getColor()` Returns the color of a link.
	`T`	`getEnd1()` Returns the first turtle of a link.
	`T`	`getEnd2()` Returns the second turtle of a link.
	`double`	`getLabelColor()` Returns the label color for a turtle or link. @ returns label color in the range [0, 140)
	`String`	`getLinkType()`
	`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.
	`void`	`hideLink()` Link appears hidden.
	`boolean`	`isHiddenQ()` Queries if caller is hidden.
	`Link`	`link(Number oneEnd, Number otherEnd)` Returns the link between two turtles.
	`Link`	`link(Turtle oneEnd, Turtle otherEnd)` Returns the link between two turtles.
	`double`	`linkHeading()` Returns the heading of a link.
	`double`	`linkLength()` Returns the length of a link.
	`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.
	`Stop`	`oldStop()` Stops a link executing within a command closure.
	`AgentSet`	`other(Collection a)` Returns an agentset minus the caller.
	`Turtle`	`otherEnd()` Returns the turtle opposite the asking turtle.
	`Patch`	`patch(Number nX, Number nY)` Returns the patch containing a point.
	`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.
	`Link`	`self()` Returns this turtle, patch, or link.
	`void`	`setColor(Number color)` Sets the color of a link to the value color.
	`void`	`setDirected(boolean directed)`
	`void`	`setEnd1(T end1)` Sets the first turtle of a link to end1.
	`void`	`setEnd2(T end2)` Sets the second turtle of a link to end2.
	`void`	`setHiddenQ(boolean hidden)` Sets link visibility.
	`void`	`setLabelColor(Number labelColor)` Sets the label color for a link to labelColor.
	`void`	`setSource(T source)`
	`void`	`setTarget(T target)`
	`void`	`setTieMode(String mode)` Sets tie mode to "none", "fixed", or "free".
	`void`	`show(Object value)` Prints value with agent identifier to the console.
	`void`	`showLink()` Makes link visible.
	`void`	`tie()` Joins together two ends of a link and ties the movements of the ends, including headings.
	`Turtle`	`turtle(Number number)` Returns the turtle of the given number.
	`AgentSet<Turtle>`	`turtles()` Returns an agentset containing all turtles.
	`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.
	`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.
	`void`	`untie()` Unties two ends of a link.
	`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
`class RepastEdge`	`getSource, getTarget, getWeight, isDirected, setDirected, setWeight`

- Property Detail
  - Number color
  - T end1
  - T end2
  - boolean hiddenQ
  - double labelColor
- Constructor Detail
  - protected Link()
- 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 askLink(Closure cl)
  - public AgentSet<Turtle> bothEnds()
    
    Returns two agents connected by link.
    returns:
    agentset of two linked agents
  - public void die()
    
    Removes the link.
  - public void fileShow(Object value)
    
    Prints value with agent identifier to current file with a newline.
    Parameters:
    value - any object
  - public void free()
    
    Joins together two ends of a link and ties the movements of the ends, except for headings.
  - public double getColor()
    
    Returns the color of a link. @ returns color of a link in the range [0, 140)
  - public T getEnd1()
    
    Returns the first turtle of a link.
    Returns:
    first turtle of a link
  - public T getEnd2()
    
    Returns the second turtle of a link.
    Returns:
    second turtle of a link
  - public double getLabelColor()
    
    Returns the label color for a turtle or link. @ returns label color in the range [0, 140)
  - public String getLinkType()
  - 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 void hideLink()
    
    Link appears hidden.
  - public boolean isHiddenQ()
    
    Queries if caller is hidden.
    Returns:
    true or false based on whether caller is hidden
  - 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 double linkHeading()
    
    Returns the heading of a link.
    Returns:
    heading of a link in degrees in the range [0, 360)
  - public double linkLength()
    
    Returns the length of a link.
    Returns:
    length of a link
  - 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
  - @Deprecatedated public public Stop oldStop()
    
    Stops a link 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 Turtle otherEnd()
    
    Returns the turtle opposite the asking turtle.
    Returns:
    turtle opposite the asking turtle
  - 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 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 Link self()
    
    Returns this turtle, patch, or link.
    Returns:
    this turtle, patch, or link.
  - public void setColor(Number color)
    
    Sets the color of a link to the value color.
    Parameters:
    color - a number
  - public void setDirected(boolean directed)
  - public void setEnd1(T end1)
    
    Sets the first turtle of a link to end1.
    Parameters:
    end1 - a turtle
  - public void setEnd2(T end2)
    
    Sets the second turtle of a link to end2.
    Parameters:
    end2 - a turtle
  - public void setHiddenQ(boolean hidden)
    
    Sets link visibility.
    Parameters:
    hidden - boolean visibility
  - public void setLabelColor(Number labelColor)
    
    Sets the label color for a link to labelColor.
    Parameters:
    labelColor - a number in range [0, 140)
  - public void setSource(T source)
  - public void setTarget(T target)
  - public void setTieMode(String mode)
    
    Sets tie mode to "none", "fixed", or "free".
    Parameters:
    mode - one of ["none", "fixed", "free"]
  - public void show(Object value)
    
    Prints value with agent identifier to the console.
    Parameters:
    value - any object
  - public void showLink()
    
    Makes link visible.
  - public void tie()
    
    Joins together two ends of a link and ties the movements of the ends, including headings.
  - 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> 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 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 void untie()
    
    Unties two ends of a link.
  - 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
Constructor
Method

| Detail:
Property
Constructor
Method

ReLogo API V2.11

[Java] Class Link<T>

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

Number color

T end1

T end2

boolean hiddenQ

double labelColor

Constructor Detail

protected Link()

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 askLink(Closure cl)

public AgentSet<Turtle> bothEnds()

public void die()

public void fileShow(Object value)

public void free()

public double getColor()

public T getEnd1()

public T getEnd2()

public double getLabelColor()

public String getLinkType()

public int getMaxPxcor()

public int getMaxPycor()

public int getMinPxcor()

public int getMinPycor()

public void hideLink()

public boolean isHiddenQ()

public Link link(Number oneEnd, Number otherEnd)

public Link link(Turtle oneEnd, Turtle otherEnd)

public double linkHeading()

public double linkLength()

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()

@Deprecatedated public public Stop oldStop()

public AgentSet other(Collection a)

public Turtle otherEnd()

public Patch patch(Number nX, Number nY)

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 Link self()

public void setColor(Number color)

public void setDirected(boolean directed)

public void setEnd1(T end1)

public void setEnd2(T end2)

public void setHiddenQ(boolean hidden)

public void setLabelColor(Number labelColor)

public void setSource(T source)

public void setTarget(T target)

public void setTieMode(String mode)

public void show(Object value)

public void showLink()

public void tie()

public Turtle turtle(Number number)

public AgentSet<Turtle> turtles()

public AgentSet<Turtle> turtlesOn(Collection a)

public AgentSet<Turtle> turtlesOn(Patch p)

public AgentSet<Turtle> turtlesOn(Turtle t)

public void untie()

public int worldHeight()

public int worldWidth()