Topology (JBotSim Project documentation)

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

All Implemented Interfaces:

ClockListener

Direct Known Subclasses:

EMEGTopology
```
public class Topology
extends Properties
implements ClockListener
```
The Topology object is the main entry point of JBotSim.
It provides several features and convenience accessors, but at its core, it contains a set of Node objects which can be linked two by two with a set of Link objects.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class Topology.DefaultCommands

static class Topology.RefreshMode

Nested Classes
Modifier and Type	Class and Description
`class`	`Topology.DefaultCommands`
`static class`	`Topology.RefreshMode`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`COMMAND_SEPARATOR` The character used as command separator.
`protected ArrayList<CommandListener>`	`commandListeners`
`protected ArrayList<String>`	`commands`
`static double`	`DEFAULT_COMMUNICATION_RANGE`
`static int`	`DEFAULT_HEIGHT`
`static String`	`DEFAULT_NODE_MODEL_NAME` The name under which the default Node model is stored.
`static Link.Orientation`	`DEFAULT_ORIENTATION`
`static double`	`DEFAULT_SENSING_RANGE`
`static int`	`DEFAULT_WIDTH`
`protected boolean`	`defaultCommandsEnabled`

Fields inherited from class io.jbotsim.core.Properties
properties

Constructor Summary

Constructors
Constructor and Description

Topology()
Creates a topology.

Topology(int width, int height)
Creates a topology of given dimensions.

Constructors
Constructor and Description
`Topology()` Creates a topology.
`Topology(int width, int height)` Creates a topology of given dimensions.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addClockListener(ClockListener listener)` Registers the specified listener to the events of the clock.
`void`	`addClockListener(ClockListener listener, int period)` Registers the specified listener to the events of the clock.
`void`	`addCommand(String command)` Adds the specified action command to this `Topology`.
`void`	`addCommandListener(CommandListener al)` Registers the specified action listener to this `Topology`.
`void`	`addConnectivityListener(ConnectivityListener listener)` Registers the specified topology listener to this topology.
`void`	`addConnectivityListener(ConnectivityListener listener, boolean directed)` Deprecated. use `addConnectivityListener(ConnectivityListener, Link.Orientation)` instead.
`void`	`addConnectivityListener(ConnectivityListener listener, Link.Orientation orientation)` Registers the specified connectivity listener to this topology.
`void`	`addLink(Link l)` Adds the specified link to this topology.
`void`	`addLink(Link l, boolean silent)` Adds the specified link to this topology without notifying the listeners (if silent is true).
`void`	`addMessageListener(MessageListener listener)` Registers the specified message listener to this topology.
`void`	`addMovementListener(MovementListener listener)` Registers the specified movement listener to this topology.
`void`	`addNode(double x, double y)` Adds a new node to this topology at the specified location.
`void`	`addNode(double x, double y, Node n)` Adds the specified node to this topology at the specified location.
`void`	`addNode(Node n)` Adds the specified node to this topology.
`void`	`addSelectionListener(SelectionListener listener)` Registers the specified selection listener to this topology.
`void`	`addStartListener(StartListener listener)` Registers the specified start listener to this topology.
`void`	`addTopologyListener(TopologyListener listener)` Registers the specified topology listener to this topology.
`void`	`clear()` Removes all the nodes (and links) of this topology.
`void`	`clearLinks()` Removes all the links of this topology.
`void`	`clearMessages()` Removes all the ongoing messages in this topology.
`void`	`disableDefaultCommands()` Disables the set of default commands provided by the `Topology` when using `getCommands()`.
`void`	`disableWireless()` Disables this node's wireless capabilities.
`void`	`enableDefaultCommands()` Enables the set of default commands provided by the `Topology` when using `getCommands()`.
`void`	`enableWireless()` Enables this node's wireless capabilities.
`void`	`executeCommand(String command)` Executes a command.
`Node`	`findNodeById(int id)` Returns the first node found with this ID.
`Class<? extends Clock>`	`getClockModel()` Returns the clock model currently in use.
`Iterable<String>`	`getCommands()` Recompute the current list of commands.
`double`	`getCommunicationRange()` Returns the default communication range.
`Class<? extends Node>`	`getDefaultNodeModel()` Returns the default node model, all properties assigned to this virtual node will be given to further nodes created without explicit model name.
`FileManager`	`getFileManager()`
`int`	`getHeight()` Returns the height of this topology.
`Link`	`getLink(Node n1, Node n2)` Returns the link shared by the specified nodes, if any.
`Link`	`getLink(Node from, Node to, boolean directed)` Deprecated. use `getLink(Node, Node, Link.Orientation)` instead.
`Link`	`getLink(Node from, Node to, Link.Orientation orientation)` Returns the link with the specified orientation between the given nodes, if any.
`LinkResolver`	`getLinkResolver()` Return the current LinkResolver.
`List<Link>`	`getLinks()` Returns a list containing all links in this topology with respect to its orientation.
`List<Link>`	`getLinks(boolean directed)` Deprecated. use `getLinks(Link.Orientation)` instead.
`List<Link>`	`getLinks(Link.Orientation orientation)` Returns a list containing all links with the specified orientation.
`MessageEngine`	`getMessageEngine()` Gets a reference on the message engine of this topology.
`Set<String>`	`getModelsNames()` Returns the set registered node classes.
`Class<? extends Node>`	`getNodeModel(String modelName)` Returns the node class corresponding to that name.
`List<Node>`	`getNodes()` Returns a list containing all the nodes in this topology.
`Link.Orientation`	`getOrientation()` Returns the orientation of the topology.
`Topology.RefreshMode`	`getRefreshMode()` Returns the current refresh mode (CLOCKBASED or EVENTBASED).
`Scheduler`	`getScheduler()` Gets a reference on the scheduler.
`double`	`getSensingRange()` Returns the default sensing range,
`TopologySerializer`	`getSerializer()` Provides a `TopologySerializer`.
`int`	`getTime()` Returns the current time (current round number)
`int`	`getTimeUnit()` Returns the global duration of a round in this topology (in millisecond).
`int`	`getWidth()` Returns the width of this topology.
`boolean`	`getWirelessStatus()` Returns true if wireless links are enabled.
`boolean`	`hasDirectedLinks()` Deprecated. see `isDirected()`
`boolean`	`isDirected()`
`boolean`	`isRunning()` Indicates whether the internal clock is currently running or in pause.
`boolean`	`isStarted()`
`Node`	`newInstanceOfModel(String modelName)` Create a new instance of this type of node.
`protected void`	`notifyLinkAdded(Link l)`
`protected void`	`notifyLinkRemoved(Link l)`
`protected void`	`notifyMessageDelivered(Message message)`
`protected void`	`notifyNodeAdded(Node node)`
`protected void`	`notifyNodeRemoved(Node node)`
`protected void`	`notifyNodeSelected(Node node)`
`void`	`onClock()` Called periodically by the central scheduler.
`void`	`pause()` Pauses the clock (or increments the pause counter).
`void`	`removeAllCommands()` Removes all commands from this `Topology`.
`void`	`removeClockListener(ClockListener listener)` Unregisters the specified listener.
`void`	`removeCommand(String command)` Removes the specified action command from this `Topology`.
`void`	`removeCommandListener(CommandListener al)` Unregisters the specified action listener to this `Topology`.
`void`	`removeConnectivityListener(ConnectivityListener listener)` Unregisters the specified connectivity listener according to the orientation of the topology.
`void`	`removeConnectivityListener(ConnectivityListener listener, boolean directed)` Deprecated. use `removeConnectivityListener(ConnectivityListener, Link.Orientation)` instead.
`void`	`removeConnectivityListener(ConnectivityListener listener, Link.Orientation orientation)` Unregisters the specified connectivity listener from the listeners of the specified orientation.
`void`	`removeLink(Link l)` Removes the specified link from this topology.
`void`	`removeMessageListener(MessageListener listener)` Unregisters the specified message listener for this topology.
`void`	`removeMovementListener(MovementListener listener)` Unregisters the specified movement listener for this topology.
`void`	`removeNode(Node n)` Removes the specified node from this topology.
`void`	`removeSelectionListener(SelectionListener listener)` Unregisters the specified selection listener for this topology.
`void`	`removeStartListener(StartListener listener)` Unregisters the specified selection listener for this topology.
`void`	`removeTopologyListener(TopologyListener listener)` Unregisters the specified topology listener.
`void`	`resetTime()` Reset the round number to 0.
`void`	`restart()` (Re)init the nodes through their onStart() method (and notifies StartListeners as well)
`void`	`resume()` Resumes the clock (or decrements the pause counter).
`void`	`selectNode(Node n)` Selects the specified `Node` in this `Topology`.
`void`	`setClockModel(Class<? extends Clock> clockModel)` Sets the clock model (to be instantiated automatically).
`void`	`setCommunicationRange(double communicationRange)` Sets the default communication range.
`void`	`setDefaultNodeModel(Class<? extends Node> nodeClass)` Sets the default node model to the given node instance.
`void`	`setDimensions(int width, int height)` Sets the topology dimensions as indicated.
`void`	`setFileManager(FileManager fileManager)`
`void`	`setLinkResolver(LinkResolver linkResolver)` Replaces the default Wireless Link Resolver by a custom one.
`void`	`setMessageEngine(MessageEngine messageEngine)` Sets the message engine of this topology.
`void`	`setNodeModel(String modelName, Class<? extends Node> nodeClass)` Adds the given node instance as a model.
`void`	`setOrientation(Link.Orientation orientation)` Set the orientation of the topology.
`void`	`setRefreshMode(Topology.RefreshMode refreshMode)` Sets the updates (links, sensed objects, etc.) to be instantaneous (EVENTBASED), or periodic after each round (CLOCKBASED).
`void`	`setScheduler(Scheduler scheduler)` Sets the scheduler of this topology.
`void`	`setSensingRange(double sensingRange)` Sets the default sensing range.
`void`	`setSerializer(TopologySerializer topologySerializer)` Sets the new `TopologySerializer` to use.
`void`	`setTimeUnit(int period)` Sets the global duration of a round in this topology (in millisecond).
`void`	`setWirelessStatus(boolean enabled)` Set wireless capabilities status
`void`	`shuffleNodeIds()` Shuffles the IDs of the nodes in this topology.
`void`	`start()` Initializes the clock.
`void`	`step()` Performs a single round, then switch to pause state.
`String`	`toString()`

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_ORIENTATION
```
public static final Link.Orientation DEFAULT_ORIENTATION
```
  - DEFAULT_WIDTH
```
public static final int DEFAULT_WIDTH
```
    See Also:
    
    Constant Field Values
  - DEFAULT_HEIGHT
```
public static final int DEFAULT_HEIGHT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_COMMUNICATION_RANGE
```
public static final double DEFAULT_COMMUNICATION_RANGE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SENSING_RANGE
```
public static final double DEFAULT_SENSING_RANGE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_NODE_MODEL_NAME
```
public static final String DEFAULT_NODE_MODEL_NAME
```
    The name under which the default Node model is stored.
    
    See Also:
    
    Constant Field Values
  - commandListeners
```
protected ArrayList<CommandListener> commandListeners
```
  - commands
```
protected ArrayList<String> commands
```
  - defaultCommandsEnabled
```
protected boolean defaultCommandsEnabled
```
  - COMMAND_SEPARATOR
```
public static final String COMMAND_SEPARATOR
```
    The character used as command separator.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Topology
```
public Topology()
```
    Creates a topology.
  - Topology
```
public Topology(int width,
                int height)
```
    Creates a topology of given dimensions.
    
    Parameters:
    
    width - the Topology's width, as an integer.
    
    height - the Topology's height, as an integer.
- Method Detail
  - getNodeModel
```
public Class<? extends Node> getNodeModel(String modelName)
```
    Returns the node class corresponding to that name.
    
    Parameters:
    
    modelName - a String identifying the node model.
    
    Returns:
    
    the node model registered for the provided modelName.
  - getDefaultNodeModel
```
public Class<? extends Node> getDefaultNodeModel()
```
    Returns the default node model, all properties assigned to this virtual node will be given to further nodes created without explicit model name.
    
    Returns:
    
    the default node model.
  - setNodeModel
```
public void setNodeModel(String modelName,
                         Class<? extends Node> nodeClass)
```
    Adds the given node instance as a model.
    
    Parameters:
    
    modelName - a String identifying the node model.
    
    nodeClass - the node model: a Class object a class extending the Node class.
  - setDefaultNodeModel
```
public void setDefaultNodeModel(Class<? extends Node> nodeClass)
```
    Sets the default node model to the given node instance.
    
    Parameters:
    
    nodeClass - the default node model: a Class object a class extending the Node class.
  - getModelsNames
```
public Set<String> getModelsNames()
```
    Returns the set registered node classes.
    
    Returns:
    
    the Set of known model names.
  - newInstanceOfModel
```
public Node newInstanceOfModel(String modelName)
```
    Create a new instance of this type of node.
    
    Parameters:
    
    modelName - a String identifying the node model.
    
    Returns:
    
    a new instance of this type of node
  - isStarted
```
public boolean isStarted()
```
  - setRefreshMode
```
public void setRefreshMode(Topology.RefreshMode refreshMode)
```
    Sets the updates (links, sensed objects, etc.) to be instantaneous (EVENTBASED), or periodic after each round (CLOCKBASED).
    
    Parameters:
    
    refreshMode - the Topology.RefreshMode to use.
  - getRefreshMode
```
public Topology.RefreshMode getRefreshMode()
```
    Returns the current refresh mode (CLOCKBASED or EVENTBASED).
    
    Returns:
    
    the current Topology.RefreshMode.
  - 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.
  - getWirelessStatus
```
public boolean getWirelessStatus()
```
    Returns true if wireless links are enabled.
    
    Returns:
    
    true if the wireless links are enabled, false otherwise.
  - getCommunicationRange
```
public double getCommunicationRange()
```
    Returns the default communication range.
    
    Returns:
    
    the default communication range
  - setCommunicationRange
```
public void setCommunicationRange(double communicationRange)
```
    Sets the default communication range. If the topology already has some nodes, their range is changed.
    
    Parameters:
    
    communicationRange - The communication range
  - getSensingRange
```
public double getSensingRange()
```
    Returns the default sensing range,
    
    Returns:
    
    the default sensing range
  - setSensingRange
```
public void setSensingRange(double sensingRange)
```
    Sets the default sensing range. If the topology already has some nodes, their range is changed.
    
    Parameters:
    
    sensingRange - The sensing range
  - getMessageEngine
```
public MessageEngine getMessageEngine()
```
    Gets a reference on the message engine of this topology.
    
    Returns:
    
    the current MessageEngine.
  - setMessageEngine
```
public void setMessageEngine(MessageEngine messageEngine)
```
    Sets the message engine of this topology.
    
    Parameters:
    
    messageEngine - the new MessageEngine.
  - getScheduler
```
public Scheduler getScheduler()
```
    Gets a reference on the scheduler.
    
    Returns:
    
    the current Scheduler.
  - setScheduler
```
public void setScheduler(Scheduler scheduler)
```
    Sets the scheduler of this topology.
    
    Parameters:
    
    scheduler - the new Scheduler.
  - getTimeUnit
```
public int getTimeUnit()
```
    Returns the global duration of a round in this topology (in millisecond).
    
    Returns:
    
    The duration
  - setTimeUnit
```
public void setTimeUnit(int period)
```
    Sets the global duration of a round in this topology (in millisecond).
    
    Parameters:
    
    period - The desired duration
  - getClockModel
```
public Class<? extends Clock> getClockModel()
```
    Returns the clock model currently in use.
    
    Returns:
    
    the current clock model.
  - setClockModel
```
public void setClockModel(Class<? extends Clock> clockModel)
```
    Sets the clock model (to be instantiated automatically).
    
    Parameters:
    
    clockModel - A class that extends JBotSim's abstract Clock
  - getTime
```
public int getTime()
```
    Returns the current time (current round number)
    
    Returns:
    
    the current time.
  - isRunning
```
public boolean isRunning()
```
    Indicates whether the internal clock is currently running or in pause.
    
    Returns:
    
    true if running, false if paused.
  - pause
```
public void pause()
```
    Pauses the clock (or increments the pause counter).
  - resume
```
public void resume()
```
    Resumes the clock (or decrements the pause counter).
  - resetTime
```
public void resetTime()
```
    Reset the round number to 0.
  - setDimensions
```
public void setDimensions(int width,
                          int height)
```
    Sets the topology dimensions as indicated.
    
    Parameters:
    
    width - the Topology's width, as an integer.
    
    height - the Topology's height, as an integer.
  - getWidth
```
public int getWidth()
```
    Returns the width of this topology.
    
    Returns:
    
    the width, as an integer.
  - getHeight
```
public int getHeight()
```
    Returns the height of this topology.
    
    Returns:
    
    the height, as an integer.
  - start
```
public void start()
```
    Initializes the clock.
  - restart
```
public void restart()
```
    (Re)init the nodes through their onStart() method (and notifies StartListeners as well)
  - clear
```
public void clear()
```
    Removes all the nodes (and links) of this topology.
  - clearLinks
```
public void clearLinks()
```
    Removes all the links of this topology.
  - clearMessages
```
public void clearMessages()
```
    Removes all the ongoing messages in this topology.
  - step
```
public void step()
```
    Performs a single round, then switch to pause state.
  - addNode
```
public void addNode(Node n)
```
    Adds the specified node to this topology. The location of the node in the topology will be its current inherent location (or (0,0) if no location was prealably given to it).
    
    Parameters:
    
    n - The node to be added.
  - addNode
```
public void addNode(double x,
                    double y)
```
    Adds a new node to this topology at the specified location.
    
    Parameters:
    
    x - The abscissa of the location.
    
    y - The ordinate of the location.
  - addNode
```
public void addNode(double x,
                    double y,
                    Node n)
```
    Adds the specified node to this topology at the specified location.
    
    Parameters:
    
    x - The abscissa of the location.
    
    y - The ordinate of the location.
    
    n - The node to be added.
  - removeNode
```
public void removeNode(Node n)
```
    Removes the specified node from this topology. All adjacent links will be automatically removed.
    
    Parameters:
    
    n - The node to be removed.
  - selectNode
```
public void selectNode(Node n)
```
    Selects the specified Node in this Topology.
    
    Parameters:
    
    n - The Node to be selected.
  - addLink
```
public void addLink(Link l)
```
    Adds the specified link to this topology. Calling this method makes sense only for wired links, since wireless links are automatically managed as per the nodes' communication ranges.
    
    Parameters:
    
    l - The link to be added.
  - addLink
```
public void addLink(Link l,
                    boolean silent)
```
    Adds the specified link to this topology without notifying the listeners (if silent is true). Calling this method makes sense only for wired links, since wireless links are automatically managed as per the nodes' communication ranges.
    
    Parameters:
    
    l - The link to be added.
    
    silent - true to disable notifications of this adding.
  - removeLink
```
public void removeLink(Link l)
```
    Removes the specified link from this topology. Calling this method makes sense only for wired links, since wireless links are automatically managed as per the nodes' communication ranges.
    
    Parameters:
    
    l - The link to be removed.
  - hasDirectedLinks
```
@Deprecated
public boolean hasDirectedLinks()
```
    Deprecated. see isDirected()
    
    Returns true if this topology has at least one directed link.
    
    Returns:
    
    true if the Topology has at least one directed link, false otherwise.
  - isDirected
```
public boolean isDirected()
```
    Returns:
    
    true if the orientation of the topology is Link.Orientation.DIRECTED
  - getNodes
```
public List<Node> getNodes()
```
    Returns a list containing all the nodes in this topology. The returned ArrayList can be subsequently modified without effect on the topology.
    
    Returns:
    
    the List of Nodes.
  - findNodeById
```
public Node findNodeById(int id)
```
    Returns the first node found with this ID.
    
    Parameters:
    
    id - an integer identifying the Node.
    
    Returns:
    
    the corresponding Node, null if not found.
  - shuffleNodeIds
```
public void shuffleNodeIds()
```
    Shuffles the IDs of the nodes in this topology.
  - getOrientation
```
public Link.Orientation getOrientation()
```
    Returns the orientation of the topology.
    
    Returns:
    
    the orientation status of the topology.
  - setOrientation
```
public void setOrientation(Link.Orientation orientation)
```
    Set the orientation of the topology.
    
    Parameters:
    
    orientation - the enforced orientation
  - getLinks
```
public List<Link> getLinks()
```
    Returns a list containing all links in this topology with respect to its orientation. The returned ArrayList can be subsequently modified without effect on the topology.
    
    Returns:
    
    the List of Links.
    
    See Also:
    
    getOrientation(), setOrientation(Link.Orientation)
  - getLinks
```
public List<Link> getLinks(Link.Orientation orientation)
```
    Returns a list containing all links with the specified orientation. The returned ArrayList can be subsequently modified without effect on the topology.
    
    Parameters:
    
    orientation - the kind of links to return.
    
    Returns:
    
    the List of Links.
  - getLinks
```
@Deprecated
public List<Link> getLinks(boolean directed)
```
    Deprecated. use getLinks(Link.Orientation) instead.
    
    Returns a list containing all links of the specified type in this topology. The returned ArrayList can be subsequently modified without effect on the topology.
    
    Parameters:
    
    directed - true for directed links, false for undirected links.
    
    Returns:
    
    the List of Links.
  - getLink
```
public Link getLink(Node n1,
                    Node n2)
```
    Returns the link shared by the specified nodes, if any. The link orientation is selected according to the orientation of the topology.
    
    Parameters:
    
    n1 - the first Node.
    
    n2 - the second Node.
    
    Returns:
    
    The requested link, if such a link exists, null otherwise.
    
    See Also:
    
    getOrientation()
  - getLink
```
public Link getLink(Node from,
                    Node to,
                    Link.Orientation orientation)
```
    Returns the link with the specified orientation between the given nodes, if any.
    
    Parameters:
    
    from - the source Node.
    
    to - the destination Node.
    
    orientation - the expected orientation of the link.
    
    Returns:
    
    The requested link, if such a link exists, null otherwise.
  - getLink
```
@Deprecated
public Link getLink(Node from,
                                Node to,
                                boolean directed)
```
    Deprecated. use getLink(Node, Node, Link.Orientation) instead.
    
    Returns the link of the specified type between the specified nodes, if any.
    
    Parameters:
    
    from - the source Node.
    
    to - the destination Node.
    
    directed - true if the searched Link is directed, false otherwise.
    
    Returns:
    
    The requested link, if such a link exists, null otherwise.
  - setLinkResolver
```
public void setLinkResolver(LinkResolver linkResolver)
```
    Replaces the default Wireless Link Resolver by a custom one.
    
    Parameters:
    
    linkResolver - An object that implements LinkResolver.
  - getLinkResolver
```
public LinkResolver getLinkResolver()
```
    Return the current LinkResolver.
    
    Returns:
    
    the current LinkResolver.
  - addConnectivityListener
```
public void addConnectivityListener(ConnectivityListener listener)
```
    Registers the specified topology listener to this topology.
    
    The listener will be notified whenever a link is added or removed. It will either receive notifications for directed or undirected links, according to the orientation of the topology when it was registered.
    
    Parameters:
    
    listener - The listener to add.
    
    See Also:
    
    getOrientation()
  - addConnectivityListener
```
@Deprecated
public void addConnectivityListener(ConnectivityListener listener,
                                                boolean directed)
```
    Deprecated. use addConnectivityListener(ConnectivityListener, Link.Orientation) instead.
    
    Registers the specified connectivity listener to this topology.
    
    The listener will be notified whenever a link of the specified orientation is added or removed.
    
    Parameters:
    
    listener - The listener to register.
    
    directed - The orientation of links to be listened, as a boolean (true for directed, false for undirected).
  - addConnectivityListener
```
public void addConnectivityListener(ConnectivityListener listener,
                                    Link.Orientation orientation)
```
    Registers the specified connectivity listener to this topology.
    
    The listener will be notified whenever a link of the specified orientation is added or removed.
    
    Parameters:
    
    listener - The listener to register.
    
    orientation - The type of orientation to be listened, as an Link.Orientation.
  - removeConnectivityListener
```
public void removeConnectivityListener(ConnectivityListener listener)
```
    Unregisters the specified connectivity listener according to the orientation of the topology.
    
    The listener will be removed from the list of listeners, according to the current orientation of the topology.
    
    Parameters:
    
    listener - The listener to unregister.
    
    See Also:
    
    getOrientation()
  - removeConnectivityListener
```
@Deprecated
public void removeConnectivityListener(ConnectivityListener listener,
                                                   boolean directed)
```
    Deprecated. use removeConnectivityListener(ConnectivityListener, Link.Orientation) instead.
    
    Unregisters the specified connectivity listener from the listeners of the specified orientation.
    
    Parameters:
    
    listener - The listener to unregister.
    
    directed - The orientation of links that this listener was listening (true for directed, false for undirected).
  - removeConnectivityListener
```
public void removeConnectivityListener(ConnectivityListener listener,
                                       Link.Orientation orientation)
```
    Unregisters the specified connectivity listener from the listeners of the specified orientation.
    
    Parameters:
    
    listener - The listener to unregister.
    
    orientation - The orientation of links that this listener was listening, as an Link.Orientation.
  - addMovementListener
```
public void addMovementListener(MovementListener listener)
```
    Registers the specified movement listener to this topology. The listener will be notified every time the location of a node changes.
    
    Parameters:
    
    listener - The movement listener.
  - removeMovementListener
```
public void removeMovementListener(MovementListener listener)
```
    Unregisters the specified movement listener for this topology.
    
    Parameters:
    
    listener - The movement listener.
  - addTopologyListener
```
public void addTopologyListener(TopologyListener listener)
```
    Registers the specified topology listener to this topology. The listener will be notified whenever a node is added or removed.
    
    Parameters:
    
    listener - The listener to register.
  - removeTopologyListener
```
public void removeTopologyListener(TopologyListener listener)
```
    Unregisters the specified topology listener.
    
    Parameters:
    
    listener - The listener to unregister.
  - addMessageListener
```
public void addMessageListener(MessageListener listener)
```
    Registers the specified message listener to this topology. The listener will be notified every time a message is received at any node.
    
    Parameters:
    
    listener - The message listener.
  - removeMessageListener
```
public void removeMessageListener(MessageListener listener)
```
    Unregisters the specified message listener for this topology.
    
    Parameters:
    
    listener - The message listener.
  - addSelectionListener
```
public void addSelectionListener(SelectionListener listener)
```
    Registers the specified selection listener to this topology. The listener will be notified every time a node is selected.
    
    Parameters:
    
    listener - The selection listener.
  - removeSelectionListener
```
public void removeSelectionListener(SelectionListener listener)
```
    Unregisters the specified selection listener for this topology.
    
    Parameters:
    
    listener - The selection listener.
  - addStartListener
```
public void addStartListener(StartListener listener)
```
    Registers the specified start listener to this topology. The listener will be notified every time a (re)start is requested on the topology.
    
    Parameters:
    
    listener - The start listener.
  - removeStartListener
```
public void removeStartListener(StartListener listener)
```
    Unregisters the specified selection listener for this topology.
    
    Parameters:
    
    listener - The start listener.
  - addClockListener
```
public void addClockListener(ClockListener listener,
                             int period)
```
    Registers the specified listener to the events of the clock.
    
    Parameters:
    
    listener - The listener to register.
    
    period - The number of rounds between consecutive onClock() events, in time units.
  - addClockListener
```
public void addClockListener(ClockListener listener)
```
    Registers the specified listener to the events of the clock.
    
    Parameters:
    
    listener - The listener to register.
  - removeClockListener
```
public void removeClockListener(ClockListener listener)
```
    Unregisters the specified listener. (The onClock() method of this listener will not longer be called.)
    
    Parameters:
    
    listener - The listener to unregister.
  - setFileManager
```
public void setFileManager(FileManager fileManager)
```
  - getFileManager
```
public FileManager getFileManager()
```
  - getSerializer
```
public TopologySerializer getSerializer()
```
    Provides a TopologySerializer.
    
    Returns:
    
    a TopologySerializer.
  - setSerializer
```
public void setSerializer(TopologySerializer topologySerializer)
```
    Sets the new TopologySerializer to use.
    
    Parameters:
    
    topologySerializer - the new TopologySerializer to use.
  - notifyLinkAdded
```
protected void notifyLinkAdded(Link l)
```
  - notifyLinkRemoved
```
protected void notifyLinkRemoved(Link l)
```
  - notifyNodeAdded
```
protected void notifyNodeAdded(Node node)
```
  - notifyNodeRemoved
```
protected void notifyNodeRemoved(Node node)
```
  - notifyNodeSelected
```
protected void notifyNodeSelected(Node node)
```
  - notifyMessageDelivered
```
protected void notifyMessageDelivered(Message message)
```
  - onClock
```
public void onClock()
```
    Description copied from interface: ClockListener
    
    Called periodically by the central scheduler.
    
    Specified by:
    
    onClock in interface ClockListener
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - addCommandListener
```
public void addCommandListener(CommandListener al)
```
    Registers the specified action listener to this Topology.
    
    Parameters:
    
    al - The listener to add.
  - removeCommandListener
```
public void removeCommandListener(CommandListener al)
```
    Unregisters the specified action listener to this Topology.
    
    Parameters:
    
    al - The listener to remove.
  - addCommand
```
public void addCommand(String command)
```
    Adds the specified action command to this Topology.
    
    Parameters:
    
    command - The command name to add.
  - removeCommand
```
public void removeCommand(String command)
```
    Removes the specified action command from this Topology.
    
    Parameters:
    
    command - The command name to remove.
  - disableDefaultCommands
```
public void disableDefaultCommands()
```
    Disables the set of default commands provided by the Topology when using getCommands().
  - enableDefaultCommands
```
public void enableDefaultCommands()
```
    Enables the set of default commands provided by the Topology when using getCommands().
  - getCommands
```
public Iterable<String> getCommands()
```
    Recompute the current list of commands.
    
    This list contains:
    - The list of default commands managed by the Topology. Please use disableDefaultCommands() to if you dont want them.
    - The list of commands which have been added by addCommand(String).
    Returns:
    
    the current list of commands
  - removeAllCommands
```
public void removeAllCommands()
```
    Removes all commands from this Topology.
  - executeCommand
```
public void executeCommand(String command)
```
    Executes a command.
    
    Parameters:
    
    command - the command to be executed

Class Topology

Nested Class Summary

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_ORIENTATION

DEFAULT_WIDTH

DEFAULT_HEIGHT

DEFAULT_COMMUNICATION_RANGE

DEFAULT_SENSING_RANGE

DEFAULT_NODE_MODEL_NAME

commandListeners

commands

defaultCommandsEnabled

COMMAND_SEPARATOR

Constructor Detail

Topology

Topology

Method Detail

getNodeModel

getDefaultNodeModel

setNodeModel

setDefaultNodeModel

getModelsNames

newInstanceOfModel

isStarted

setRefreshMode

getRefreshMode

enableWireless

disableWireless

setWirelessStatus

getWirelessStatus

getCommunicationRange

setCommunicationRange

getSensingRange

setSensingRange

getMessageEngine

setMessageEngine

getScheduler

setScheduler

getTimeUnit

setTimeUnit

getClockModel

setClockModel

getTime

isRunning

pause

resume

resetTime

setDimensions

getWidth

getHeight

start

restart

clear

clearLinks

clearMessages

step

addNode

addNode

addNode

removeNode

selectNode

addLink

addLink

removeLink

hasDirectedLinks

isDirected

getNodes

findNodeById

shuffleNodeIds

getOrientation

setOrientation

getLinks

getLinks

getLinks