Node (JBotSim Project documentation)

java.lang.Object
- io.jbotsim.core.Properties
- - io.jbotsim.core.Node

All Implemented Interfaces:

ClockListener, java.lang.Comparable<Node>
```
public class Node
extends Properties
implements ClockListener, java.lang.Comparable<Node>
```
The Node object is one of the main component of JBotSim, since it encodes an element of the graph/network. It is used by the Topology along with the Link object to represent the graph.

Any behavior modification should be implemented by subclassing this class.

Field Summary

Fields
Modifier and Type Field and Description

static Color DEFAULT_COLOR

static double DEFAULT_DIRECTION

static int DEFAULT_ICON_SIZE
- Fields inherited from class io.jbotsim.core.Properties
  properties

Fields
Modifier and Type	Field and Description
`static Color`	`DEFAULT_COLOR`
`static double`	`DEFAULT_DIRECTION`
`static int`	`DEFAULT_ICON_SIZE`

Constructor Summary

Constructors
Constructor and Description

Node()

Constructors
Constructor and Description
`Node()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`compareTo(Node o)`
`void`	`die()` Request the `Node` to die by the end of the round.
`void`	`disableWireless()` Disables this node's wireless capabilities.
`double`	`distance(double x, double y)` Returns the distance between this node and the specified 2D location.
`double`	`distance(double x, double y, double z)` Returns the distance between this node and the specified 3D location.
`double`	`distance(Node n)` Returns the distance between this node and the specified node.
`double`	`distance(Point p)` Returns the distance between this node and the specified 3D location.
`void`	`enableWireless()` Enables this node's wireless capabilities.
`Color`	`getColor()` Returns the color of this node.
`Link`	`getCommonLinkWith(Node n)` Returns the undirected link whose endpoints are this node and the specified node, if any such link exists.
`double`	`getCommunicationRange()` Returns the communication range of this node (as a radius).
`double`	`getDirection()` Returns the current direction angle of this node (in radians).
`java.lang.String`	`getIcon()` Returns the icon of the this node.
`int`	`getIconSize()` Returns the `Node`'s icon's desired size.
`int`	`getID()` Returns the identifier of this node.
`Link`	`getInLinkFrom(Node n)` Returns the directed link whose destination is this node and sender is the specified node, if any such link exists.
`java.util.List<Link>`	`getInLinks()` Returns a list containing all links for which this node is the destination.
`java.util.List<Node>`	`getInNeighbors()` Returns a list containing every node serving as source for an adjacent directed link.
`java.lang.Object`	`getLabel()` Returns the label of this node.
`java.util.List<Link>`	`getLinks()` Returns a list containing all undirected links adjacent to this node.
`java.util.List<Link>`	`getLinks(boolean directed)` Returns a list containing all adjacent links of the specified type.
`Point`	`getLocation()` Returns the location of this node.
`java.util.List<Message>`	`getMailbox()` Returns a list of messages representing the mailbox of this node.
`java.util.List<Node>`	`getNeighbors()` Returns a list containing every node located at the opposite endpoint of an adjacent undirected links.
`java.util.List<Message>`	`getOutbox()` Returns a list of the messages that this node is about to send.
`java.util.List<Link>`	`getOutLinks()` Returns a list containing all links for which this node is the sender.
`Link`	`getOutLinkTo(Node n)` Returns the directed link whose sender is this node and destination is the specified node, if any such link exists.
`java.util.List<Node>`	`getOutNeighbors()` Returns a list containing every node serving as destination for an adjacent directed link.
`java.util.List<Node>`	`getSensedNodes()` Returns a list containing every node located within the sensing range The returned list can be modified without side effect.
`double`	`getSensingRange()` Returns the sensing range of this node (as a radius).
`int`	`getTime()` Returns the current time (current round number).
`Topology`	`getTopology()` Returns the parent `Topology` of this node, if any.
`double`	`getX()` Returns the x-coordinate of this node.
`double`	`getY()` Returns the y-coordinate of this node.
`double`	`getZ()` Returns the z-coordinate of this node.
`boolean`	`hasNeighbors()` Indicates whether this node has at least one neighbor (undirected)
`boolean`	`isDying()` Returns the dying status of the `Node`.
`boolean`	`isWirelessEnabled()` Indicates whether this node has wireless capabilities enabled.
`void`	`move()` Translates the location of this node by one unit towards the node's current direction.
`void`	`move(double distance)` Translates the location of this node by the specified distance towards the node's current direction.
`protected void`	`notifyNodeMoved()`
`void`	`onClock()` Override this method to perform some action upon clock pulse.
`void`	`onDirectedLinkAdded(Link link)` Called when an adjacent directed link is added.
`void`	`onDirectedLinkRemoved(Link link)` Called when an adjacent directed link is removed.
`void`	`onLinkAdded(Link link)` Called when an adjacent undirected link is added.
`void`	`onLinkRemoved(Link link)` Called when an adjacent undirected link is removed.
`void`	`onMessage(Message message)` Called when this node receives a `Message`.
`void`	`onMovement()` Override this method to perform some action when the node moves.
`void`	`onPostClock()` Override this method to perform some action just after clock pulse.
`void`	`onPreClock()` Override this method to perform some action just before clock pulse.
`void`	`onSelection()` Called when this node is selected (e.g. middle click in the UI)
`void`	`onSensingIn(Node node)` Called when another node is sensed for the first time.
`void`	`onSensingOut(Node node)` Called when a sensed node is no more sensed.
`void`	`onStart()` Override this method to re-initialise your node (e.g. your variables).
`void`	`onStop()` This method is called just before the node is removed from the topology.
`void`	`send(Node destination, Message message)` Sends a message from this node to the specified destination node.
`void`	`send(Node destination, java.lang.Object content)` Deprecated. Please use `send(Node, Message)` instead.
`void`	`sendAll(Message message)` Sends a message to all neighbors.
`void`	`sendAll(java.lang.Object content)` Deprecated. Please use `sendAll(Message)` instead.
`void`	`sendRetry(Node destination, Message message)` Same method as `send()`, but retries to send the message later if the link to the destination disappeared during transmission.
`void`	`sendRetry(Node destination, java.lang.Object content)` Deprecated. Please use `sendRetry(Node, Message)` instead.
`void`	`setColor(Color color)` Sets the color of this node.
`void`	`setCommunicationRange(double range)` Activates the wireless capabilities of this node and sets its communication range to the specified radius.
`void`	`setDirection(double angle)` Sets the direction angle of this node (in radians).
`void`	`setDirection(Point p)` Sets the direction angle of this node using the specified reference point.
`void`	`setDirection(Point p, boolean opposite)` Sets the direction angle of this node using the specified reference point.
`void`	`setIcon(java.lang.String fileName)` Sets the icon of this node.
`void`	`setIconSize(int iconSize)` Sets the `Node`'s icon's desired size.
`void`	`setID(int ID)` Sets the identifier of this node.
`void`	`setLabel(java.lang.Object label)` Sets the label of this node.
`void`	`setLocation(double x, double y)` Changes this node's location to the specified coordinates.
`void`	`setLocation(double x, double y, double z)` Changes this node's location to the specified coordinates.
`void`	`setLocation(Point loc)` Changes this node's location to the specified 2D point.
`void`	`setSensingRange(double range)` Sets the sensing range of this node to the specified radius.
`void`	`setWirelessStatus(boolean enabled)` Set wireless capabilities status
`java.lang.String`	`toString()` Returns a string representation of this node.
`void`	`translate(double dx, double dy)` Translates the location of this node by the specified coordinates.
`void`	`translate(double dx, double dy, double dz)` Translates the location of this node by the specified coordinates.
`void`	`wrapLocation()` Changes this node's location modulo the iconSize of topology.

Methods inherited from class io.jbotsim.core.Properties
addPropertyListener, getProperty, hasProperty, removeProperty, removePropertyListener, setProperty

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_COLOR
```
public static final Color DEFAULT_COLOR
```
  - DEFAULT_ICON_SIZE
```
public static final int DEFAULT_ICON_SIZE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_DIRECTION
```
public static final double DEFAULT_DIRECTION
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Node
```
public Node()
```
- Method Detail
  - getID
```
public int getID()
```
    Returns the identifier of this node.
    
    Returns:
    
    The identifier as an integer.
  - setID
```
public void setID(int ID)
```
    Sets the identifier of this node. Nodes have an identifier by default, which is the smallest available integer.
    
    Parameters:
    
    ID - the new identifier.
  - getTopology
```
public Topology getTopology()
```
    Returns the parent Topology of this node, if any.
    
    Returns:
    
    The parent Topology, or null if the node is orphan.
  - onSelection
```
public void onSelection()
```
    Called when this node is selected (e.g. middle click in the UI)
  - onStart
```
public void onStart()
```
    Override this method to re-initialise your node (e.g. your variables). This method is also called when a node is added to the topology (or when the topology starts, if not yet started).
  - onStop
```
public void onStop()
```
    This method is called just before the node is removed from the topology.
  - onPreClock
```
public void onPreClock()
```
    Override this method to perform some action just before clock pulse.
  - onClock
```
public void onClock()
```
    Override this method to perform some action upon clock pulse.
    
    Specified by:
    
    onClock in interface ClockListener
  - onPostClock
```
public void onPostClock()
```
    Override this method to perform some action just after clock pulse.
  - onMovement
```
public void onMovement()
```
    Override this method to perform some action when the node moves.
  - onMessage
```
public void onMessage(Message message)
```
    Called when this node receives a Message.
    
    Parameters:
    
    message - the received Message.
  - onLinkAdded
```
public void onLinkAdded(Link link)
```
    Called when an adjacent undirected link is added.
    
    Parameters:
    
    link - the added Link.
  - onLinkRemoved
```
public void onLinkRemoved(Link link)
```
    Called when an adjacent undirected link is removed.
    
    Parameters:
    
    link - the removed Link.
  - onDirectedLinkAdded
```
public void onDirectedLinkAdded(Link link)
```
    Called when an adjacent directed link is added.
    
    Parameters:
    
    link - the added Link.
  - onDirectedLinkRemoved
```
public void onDirectedLinkRemoved(Link link)
```
    Called when an adjacent directed link is removed.
    
    Parameters:
    
    link - the removed Link.
  - onSensingIn
```
public void onSensingIn(Node node)
```
    Called when another node is sensed for the first time.
    
    Parameters:
    
    node - the Node that has been sensed.
  - onSensingOut
```
public void onSensingOut(Node node)
```
    Called when a sensed node is no more sensed.
    
    Parameters:
    
    node - the Node that is not sensed anymore.
  - die
```
public void die()
```
    Request the Node to die by the end of the round.
  - isDying
```
public boolean isDying()
```
    Returns the dying status of the Node.
    
    Returns:
    
    true if the Node is dying or already dead; returns false otherwise.
  - getX
```
public double getX()
```
    Returns the x-coordinate of this node.
    
    Returns:
    
    the x-coordinate, as a double.
  - getY
```
public double getY()
```
    Returns the y-coordinate of this node.
    
    Returns:
    
    the y-coordinate, as a double.
  - getZ
```
public double getZ()
```
    Returns the z-coordinate of this node.
    
    Returns:
    
    the z-coordinate, as a double.
  - getColor
```
public Color getColor()
```
    Returns the color of this node.
    
    Returns:
    
    the Node's Color.
  - setColor
```
public void setColor(Color color)
```
    Sets the color of this node.
    
    Parameters:
    
    color - the Node's new Color.
  - setIcon
```
public void setIcon(java.lang.String fileName)
```
    Sets the icon of this node. The argument must be an absolute path to either a file in the file system, or a resource in the application. Examples:
```
 
     node.setIcon("/filesystem/path/to/image");
     node.setIcon("/package/path/to/image");
 
 
```
    Parameters:
    
    fileName - a String leading to the icon.
  - getIcon
```
public java.lang.String getIcon()
```
    Returns the icon of the this node.
    
    Returns:
    
    a String leading to the icon.
  - getIconSize
```
public int getIconSize()
```
    Returns the Node's icon's desired size.
    
    Returns:
    
    the desired size of this Node's icon, as an integer.
  - setIconSize
```
public void setIconSize(int iconSize)
```
    Sets the Node's icon's desired size.
    
    Parameters:
    
    iconSize - the new desired size of this Node's icon, as an integer.
  - getLabel
```
public java.lang.Object getLabel()
```
    Returns the label of this node.
    
    Returns:
    
    the label of the node, as an Object.
  - setLabel
```
public void setLabel(java.lang.Object label)
```
    Sets the label of this node. Default GUI shows it as tooltip when the mouse cursor is held some time over the node.
    
    Parameters:
    
    label - the Object representing the new label of the node.
  - getCommunicationRange
```
public double getCommunicationRange()
```
    Returns the communication range of this node (as a radius).
    
    Returns:
    
    the current communication range.
  - setCommunicationRange
```
public void setCommunicationRange(double range)
```
    Activates the wireless capabilities of this node and sets its communication range to the specified radius. This determines the distance up to which this node can send messages to other nodes.
    
    Parameters:
    
    range - the new communication range, as a double.
  - isWirelessEnabled
```
public boolean isWirelessEnabled()
```
    Indicates whether this node has wireless capabilities enabled.
    
    Returns:
    
    true if the wireless capabilities are enabled, false otherwise.
  - enableWireless
```
public void enableWireless()
```
    Enables this node's wireless capabilities.
  - disableWireless
```
public void disableWireless()
```
    Disables this node's wireless capabilities.
  - setWirelessStatus
```
public void setWirelessStatus(boolean enabled)
```
    Set wireless capabilities status
    
    Parameters:
    
    enabled - the new wireless status: true to enable, false otherwise.
  - getSensingRange
```
public double getSensingRange()
```
    Returns the sensing range of this node (as a radius).
    
    Returns:
    
    the current sensing range.
  - setSensingRange
```
public void setSensingRange(double range)
```
    Sets the sensing range of this node to the specified radius.
    
    Parameters:
    
    range - the new sensing range, as a double.
  - getLocation
```
public Point getLocation()
```
    Returns the location of this node.
    
    Returns:
    
    the current location of this node, as a Point.
  - setLocation
```
public void setLocation(double x,
                        double y)
```
    Changes this node's location to the specified coordinates.
    
    Parameters:
    
    x - The abscissa of the new location.
    
    y - The ordinate of the new location.
  - setLocation
```
public void setLocation(double x,
                        double y,
                        double z)
```
    Changes this node's location to the specified coordinates.
    
    Parameters:
    
    x - The abscissa of the new location.
    
    y - The ordinate of the new location.
    
    z - The ordinate of the new location.
  - setLocation
```
public void setLocation(Point loc)
```
    Changes this node's location to the specified 2D point.
    
    Parameters:
    
    loc - The new location point.
  - wrapLocation
```
public void wrapLocation()
```
    Changes this node's location modulo the iconSize of topology.
  - translate
```
public void translate(double dx,
                      double dy)
```
    Translates the location of this node by the specified coordinates.
    
    Parameters:
    
    dx - The abscissa component.
    
    dy - The ordinate component.
  - translate
```
public void translate(double dx,
                      double dy,
                      double dz)
```
    Translates the location of this node by the specified coordinates.
    
    Parameters:
    
    dx - The abscissa component.
    
    dy - The ordinate component.
    
    dz - The applicate component.
  - getTime
```
public int getTime()
```
    Returns the current time (current round number).
    
    Returns:
    
    the current time.
  - getDirection
```
public double getDirection()
```
    Returns the current direction angle of this node (in radians).
    
    Returns:
    
    the current direction.
  - setDirection
```
public void setDirection(double angle)
```
    Sets the direction angle of this node (in radians).
    
    Parameters:
    
    angle - The angle in radians.
  - setDirection
```
public void setDirection(Point p)
```
    Sets the direction angle of this node using the specified reference point. Only the resulting angle matters (not the particular location of the reference point).
    
    Parameters:
    
    p - The reference Point.
  - setDirection
```
public void setDirection(Point p,
                         boolean opposite)
```
    Sets the direction angle of this node using the specified reference point. Only the resulting angle matters (not the particular location of the reference point).
    
    Parameters:
    
    p - The reference Point.
    
    opposite - true if the new direction should be the opposite of the reference point.
  - move
```
public void move()
```
    Translates the location of this node by one unit towards the node's current direction.
  - move
```
public void move(double distance)
```
    Translates the location of this node by the specified distance towards the node's current direction.
    
    Parameters:
    
    distance - the distance by which the Node should be moved.
  - getInLinkFrom
```
public Link getInLinkFrom(Node n)
```
    Returns the directed link whose destination is this node and sender is the specified node, if any such link exists.
    
    Parameters:
    
    n - The sender node.
    
    Returns:
    
    The requested link, or null if no such link is found.
  - getOutLinkTo
```
public Link getOutLinkTo(Node n)
```
    Returns the directed link whose sender is this node and destination is the specified node, if any such link exists.
    
    Parameters:
    
    n - The destination node.
    
    Returns:
    
    The requested link, or null if no such link is found.
  - getCommonLinkWith
```
public Link getCommonLinkWith(Node n)
```
    Returns the undirected link whose endpoints are this node and the specified node, if any such link exists.
    
    Parameters:
    
    n - The node at the opposite endpoint.
    
    Returns:
    
    The requested link, or null if no such link is found.
  - getInLinks
```
public java.util.List<Link> getInLinks()
```
    Returns a list containing all links for which this node is the destination. The returned list can be subsequently modified without effect on the topology.
    
    Returns:
    
    the List of inbound Links.
  - getOutLinks
```
public java.util.List<Link> getOutLinks()
```
    Returns a list containing all links for which this node is the sender. The returned list can be subsequently modified without effect on the topology.
    
    Returns:
    
    the List of outbound Links.
  - getLinks
```
public java.util.List<Link> getLinks()
```
    Returns a list containing all undirected links adjacent to this node. The returned list can be subsequently modified without effect on the topology.
    
    Returns:
    
    the List of Links
  - getLinks
```
public java.util.List<Link> getLinks(boolean directed)
```
    Returns a list containing all adjacent links of the specified type.
    
    Parameters:
    
    directed - true for directed, false for undirected. The returned list can be subsequently modified without effect on the topology.
    
    Returns:
    
    the List of Links
  - getInNeighbors
```
public java.util.List<Node> getInNeighbors()
```
    Returns a list containing every node serving as source for an adjacent directed link. The returned list can be subsequently modified without effect on the topology.
    
    Returns:
    
    A list containing the neighbors, with possible duplicates when several links come from a same neighbor.
  - getOutNeighbors
```
public java.util.List<Node> getOutNeighbors()
```
    Returns a list containing every node serving as destination for an adjacent directed link. The returned list can be subsequently modified without effect on the topology.
    
    Returns:
    
    A list containing the neighbors, with possible duplicates when several links go towards a same neighbor.
  - getSensedNodes
```
public java.util.List<Node> getSensedNodes()
```
    Returns a list containing every node located within the sensing range The returned list can be modified without side effect.
    
    Returns:
    
    A list containing all nodes within sensing range
  - hasNeighbors
```
public boolean hasNeighbors()
```
    Indicates whether this node has at least one neighbor (undirected)
    
    Returns:
    
    true if it does, false if it does not.
  - getNeighbors
```
public java.util.List<Node> getNeighbors()
```
    Returns a list containing every node located at the opposite endpoint of an adjacent undirected links. The returned list can be subsequently modified without effect on the topology.
    
    Returns:
    
    A list containing the neighbors, with possible duplicates when several links are shared with a same neighbor.
  - getMailbox
```
public java.util.List<Message> getMailbox()
```
    Returns a list of messages representing the mailbox of this node. The mailbox can be useful to scrutinize new messages in a non-event, round-based way (as opposed to the onMessage() method), or to clear previous messages (since all received messages are retained in the mailbox). The returned list must be considered as the original copy of the node's mailbox.
    
    Returns:
    
    the List of incoming Messages
  - getOutbox
```
public java.util.List<Message> getOutbox()
```
    Returns a list of the messages that this node is about to send.
    
    Returns:
    
    the List of outgoing Messages
  - send
```
public void send(Node destination,
                 Message message)
```
    Sends a message from this node to the specified destination node. The content of the message is specified as an object reference, to be passed 'as is' to the destination(s). The effective transmission will occur at the x^th following clock step, where x is the message delay specified by the static method Message.setMessageDelay (1 by default).
    
    Parameters:
    
    destination - The destination node.
    
    message - The message to be sent.
  - send
```
@Deprecated
public void send(Node destination,
                             java.lang.Object content)
```
    Deprecated. Please use send(Node, Message) instead.
    
    Same as send(), but the content is directly given as parameter (a message will be created to contain it).
    
    Parameters:
    
    destination - The non-null destination.
    
    content - The object to be sent.
  - sendRetry
```
public void sendRetry(Node destination,
                      Message message)
```
    Same method as send(), but retries to send the message later if the link to the destination disappeared during transmission. (Does not work for null destinations.)
    
    Parameters:
    
    destination - The non-null destination.
    
    message - The message.
  - sendRetry
```
@Deprecated
public void sendRetry(Node destination,
                                  java.lang.Object content)
```
    Deprecated. Please use sendRetry(Node, Message) instead.
    
    Same as sendRetry(), but the content is directly given as parameter (a message will be created to contain it).
    
    Parameters:
    
    destination - The non-null destination.
    
    content - The object to be sent.
  - sendAll
```
public void sendAll(Message message)
```
    Sends a message to all neighbors. The content of the message is specified as an object reference, to be passed 'as is' to the destination(s). The effective transmission will occur at the x^th following clock step, where x is the message delay specified by the static method Message.setMessageDelay (1 by default).
    
    Parameters:
    
    message - The message to be sent.
  - sendAll
```
@Deprecated
public void sendAll(java.lang.Object content)
```
    Deprecated. Please use sendAll(Message) instead.
    
    Same as sendAll(), but the content is directly given as parameter (a message will be created to contain it).
    
    Parameters:
    
    content - The object to be sent.
  - distance
```
public double distance(Node n)
```
    Returns the distance between this node and the specified node.
    
    Parameters:
    
    n - The other node.
    
    Returns:
    
    the distance, as a double.
  - distance
```
public double distance(double x,
                       double y)
```
    Returns the distance between this node and the specified 2D location.
    
    Parameters:
    
    x - The abscissa of the point to which the distance is measured.
    
    y - The ordinate of the point to which the distance is measured.
    
    Returns:
    
    the distance, as a double.
  - distance
```
public double distance(Point p)
```
    Returns the distance between this node and the specified 3D location.
    
    Parameters:
    
    p - The location (as a 3D point).
    
    Returns:
    
    the distance, as a double.
  - distance
```
public double distance(double x,
                       double y,
                       double z)
```
    Returns the distance between this node and the specified 3D location.
    
    Parameters:
    
    x - The abscissa of the point to which the distance is measured.
    
    y - The ordinate of the point to which the distance is measured.
    
    z - The applicate of the point to which the distance is measured.
    
    Returns:
    
    the distance, as a double.
  - notifyNodeMoved
```
protected void notifyNodeMoved()
```
  - compareTo
```
public int compareTo(Node o)
```
    Specified by:
    
    compareTo in interface java.lang.Comparable<Node>
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this node.
    
    Overrides:
    
    toString in class java.lang.Object

Class Node

Field Summary

Fields inherited from class io.jbotsim.core.Properties

Constructor Summary

Method Summary

Methods inherited from class io.jbotsim.core.Properties

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_COLOR

DEFAULT_ICON_SIZE

DEFAULT_DIRECTION

Constructor Detail

Node

Method Detail

getID

setID

getTopology

onSelection

onStart

onStop

onPreClock

onClock

onPostClock

onMovement

onMessage

onLinkAdded

onLinkRemoved

onDirectedLinkAdded

onDirectedLinkRemoved

onSensingIn

onSensingOut

die

isDying

getX

getY

getZ

getColor

setColor

setIcon

getIcon

getIconSize

setIconSize

getLabel

setLabel

getCommunicationRange

setCommunicationRange

isWirelessEnabled

enableWireless

disableWireless

setWirelessStatus

getSensingRange

setSensingRange

getLocation

setLocation

setLocation

setLocation

wrapLocation

translate

translate

getTime

getDirection

setDirection

setDirection

setDirection

move

move

getInLinkFrom

getOutLinkTo

getCommonLinkWith

getInLinks

getOutLinks

getLinks

getLinks

getInNeighbors

getOutNeighbors

getSensedNodes

hasNeighbors

getNeighbors

getMailbox

getOutbox