io.jbotsim.core

Class Link

java.lang.Object

io.jbotsim.core.Properties

io.jbotsim.core.Link

All Implemented Interfaces:

Comparable<Link>

Direct Known Subclasses:

TVLink

public class Link
extends Properties
implements Comparable<Link>

The Link object encodes a communication link between two Nodes.

Links can either be Link.Orientation.DIRECTED or Link.Orientation.UNDIRECTED, and either Link.Mode.WIRED or Link.Mode.WIRELESS. The by default, a link will be Link.Orientation.UNDIRECTED and Link.Mode.WIRELESS.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Link.Mode Enumerates the two possible modes of a link: Mode.WIRED and Mode.WIRELESS.
static class	Link.Orientation Enumerates the two possible types of a link: Orientation.DIRECTED and Orientation.UNDIRECTED.

Field Summary

Fields

Modifier and Type	Field and Description
static Color	DEFAULT_COLOR
static Link.Mode	DEFAULT_MODE
static Link.Orientation	DEFAULT_ORIENTATION
static int	DEFAULT_WIDTH
Node	destination The destination node of this link (if directed), the second endpoint otherwise.
Link.Mode	mode The Mode of this link (wired/wireless)
Link.Orientation	orientation The Orientation of this link (directed/undirected)
Node	source The source node of this link (if directed), the first endpoint otherwise.

Fields inherited from class io.jbotsim.core.Properties

properties

Constructor Summary

Constructors

Constructor and Description
Link(Node n1, Node n2) Creates an undirected wired link between the two specified nodes.
Link(Node from, Node to, Link.Mode mode) Creates a link with the specified mode between the nodes from and to.
Link(Node from, Node to, Link.Orientation orientation) Creates a wired link of the specified orientation between the nodes from and to.
Link(Node from, Node to, Link.Orientation orientation, Link.Mode mode) Creates a link of the specified orientation with the specified mode between the nodes from and to.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Link l) Compares the specified link to this link in terms of length.
Node	endpoint(int index) Returns the requested endpoint node of this link
List<Node>	endpoints() Returns an list containing the two endpoint nodes of this link
boolean	equals(Object o) Compares the specified object with this link for equality.
Color	getColor() Returns the color of this link.
Double	getLength() Returns the euclidean distance between this link endpoints.
Node	getOtherEndpoint(Node n) Returns the node located at the opposite of the specified node (reference node) on the underlying link.
Topology	getTopology() Returns the parent topology of this link, if any.
Integer	getWidth() Returns the width of this link.
boolean	isDirected() Tests whether the orientation is DIRECTED.
boolean	isWireless() Tests whether the mode is WIRELESS.
void	setColor(Color color) Sets the color of this link
void	setWidth(Integer width) Sets the width of this link.
String	toString() Returns a string representation of this link.

Methods inherited from class io.jbotsim.core.Properties

addPropertyListener, getProperty, hasProperty, removeProperty, removePropertyListener, setProperty

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_COLOR

public static final Color DEFAULT_COLOR

DEFAULT_WIDTH

public static final int DEFAULT_WIDTH

See Also:

Constant Field Values

DEFAULT_ORIENTATION

public static final Link.Orientation DEFAULT_ORIENTATION

DEFAULT_MODE

public static final Link.Mode DEFAULT_MODE

source

public Node source

The source node of this link (if directed), the first endpoint otherwise.

destination

public Node destination

The destination node of this link (if directed), the second endpoint otherwise.

orientation

public Link.Orientation orientation

The Orientation of this link (directed/undirected)

mode

public Link.Mode mode

The Mode of this link (wired/wireless)

Constructor Detail

Link

public Link(Node n1,
            Node n2)

Creates an undirected wired link between the two specified nodes.

Parameters:

n1 - The source node.

n2 - The destination node.

Link

public Link(Node from,
            Node to,
            Link.Orientation orientation)

Creates a wired link of the specified orientation between the nodes from and to. The respective order of from and to does not matter if the specified orientation is undirected.

Parameters:

from - The source node.

to - The destination node.

orientation - The orientation of the link (Orientation.DIRECTED or Orientatino.UNDIRECTED).

Link

public Link(Node from,
            Node to,
            Link.Mode mode)

Creates a link with the specified mode between the nodes from and to. The created link is undirected by default. The respective order of from and to does not matter.

Parameters:

from - The source node.

to - The destination node.

mode - The mode of the link (Mode.WIRED or Mode.WIRELESS).

Link

public Link(Node from,
            Node to,
            Link.Orientation orientation,
            Link.Mode mode)

Creates a link of the specified orientation with the specified mode between the nodes from and to. The created link is wired by default. The respective order of from and to does not matter if the orientation is undirected.

Parameters:

from - The source node.

to - The destination node.

orientation - The orientation of the link (Orientation.DIRECTED or Orientation.UNDIRECTED).

mode - The mode of the link (Mode.WIRED or Mode.WIRELESS).

Method Detail

endpoints

public List<Node> endpoints()

Returns an list containing the two endpoint nodes of this link

Returns:

The endpoints.

endpoint

public Node endpoint(int index)

Returns the requested endpoint node of this link

Parameters:

index - The endpoint index (0 or 1).

Returns:

The endpoint.

getOtherEndpoint

public Node getOtherEndpoint(Node n)

Returns the node located at the opposite of the specified node (reference node) on the underlying link.

Parameters:

n - The reference node.

Returns:

The opposite node.

getTopology

public Topology getTopology()

Returns the parent topology of this link, if any.

Returns:

The parent topology, or null if the link has none.

getColor

public Color getColor()

Returns the color of this link.

Returns:

the Color of the link.

setColor

public void setColor(Color color)

Sets the color of this link

Parameters:

color - the new Color of the link.

getWidth

public Integer getWidth()

Returns the width of this link.

Returns:

the width of this link.

setWidth

public void setWidth(Integer width)

Sets the width of this link.

Parameters:

width - the width of this link.

getLength

public Double getLength()

Returns the euclidean distance between this link endpoints.

Returns:

the length between the endpoints, as a Double.

isWireless

public boolean isWireless()

Tests whether the mode is WIRELESS.

Returns:

true if the link mode is WIRELESS, false otherwise.

isDirected

public boolean isDirected()

Tests whether the orientation is DIRECTED.

Returns:

true if the link orientation is DIRECTED, false otherwise.

equals

public boolean equals(Object o)

Compares the specified object with this link for equality. Returns true if both links have the same orientation (directed/undirected) and the same endpoints (interchangeably if undirected). The mode is not considered by the equality test.

Overrides:

equals in class Object

compareTo

public int compareTo(Link l)

Compares the specified link to this link in terms of length.

Specified by:

compareTo in interface Comparable<Link>

toString

public String toString()

Returns a string representation of this link.

Overrides:

toString in class Object