io.jbotsim.gen.basic.generators

Class RingGenerator

java.lang.Object

io.jbotsim.gen.basic.generators.AbstractGenerator

io.jbotsim.gen.basic.generators.RingGenerator

All Implemented Interfaces:

TopologyGenerator

Direct Known Subclasses:

KNGenerator

public class RingGenerator
extends AbstractGenerator

The RingGenerator is a TopologyGenerator used to create a ring.

The size of the generated ring is defined by its width (setWidth(double)) and height (setHeight(double)).

Field Summary

Fields inherited from class io.jbotsim.gen.basic.generators.AbstractGenerator

absoluteCoords, dimensionsMap, directed, FIRST_DIMENSION_INDEX, nbNodesMap, nodeClass, SECOND_DIMENSION_INDEX, wired, wirelessEnabled, x, y

Constructor Summary

Constructors

Constructor and Description
RingGenerator(int nbNodes) Creates a RingGenerator creating a ring of nbNodes Nodes.

Method Summary

Modifier and Type	Method and Description
protected void	addLinks(Topology tp, int nbNodes, Node[] nodes)
void	generate(Topology topology) Modifies the provided Topology according to the implementation.
protected Node[]	generateNodes(Topology tp, int nbNodes)
double	getHeight() Gets the height of the generated pattern (2 dimensions).
double	getWidth() Gets the width of the generated pattern (2 dimensions).
AbstractGenerator	setHeight(double height) Sets the height of the generated pattern (2 dimensions).
AbstractGenerator	setWidth(double width) Sets the width of the generated pattern (2 dimensions).

Methods inherited from class io.jbotsim.gen.basic.generators.AbstractGenerator

addNodeAtLocation, getAbsoluteHeight, getAbsoluteWidth, getAbsoluteX, getAbsoluteY, getDimension, getNbNodes, getNbNodes, getNodeClass, getSize, getX, getY, isAbsoluteCoords, isDirected, isWired, isWirelessEnabled, setAbsoluteCoords, setDefaultWidthHeight, setDimension, setDirected, setNbNodes, setNbNodes, setNodeClass, setSize, setWired, setWirelessEnabled, setX, setY

Methods inherited from class java.lang.Object

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

Constructor Detail

RingGenerator

public RingGenerator(int nbNodes)

Creates a RingGenerator creating a ring of nbNodes Nodes.

Parameters:

nbNodes - the number of Nodes to be added.

Method Detail

generate

public void generate(Topology topology)

Description copied from interface: TopologyGenerator

Modifies the provided Topology according to the implementation.

Parameters:

topology - the Topology to be modified by the generation

generateNodes

protected Node[] generateNodes(Topology tp,
                               int nbNodes)
                        throws ReflectiveOperationException

Throws:

ReflectiveOperationException

addLinks

protected void addLinks(Topology tp,
                        int nbNodes,
                        Node[] nodes)

setWidth

public AbstractGenerator setWidth(double width)

Description copied from class: AbstractGenerator

Sets the width of the generated pattern (2 dimensions).

Overrides:

setWidth in class AbstractGenerator

Parameters:

width - the desired width, as a double.

Returns:

a reference to the object.

setHeight

public AbstractGenerator setHeight(double height)

Description copied from class: AbstractGenerator

Sets the height of the generated pattern (2 dimensions).

Overrides:

setHeight in class AbstractGenerator

Parameters:

height - the desired height, as a double.

Returns:

a reference to the object.

getWidth

public double getWidth()

Description copied from class: AbstractGenerator

Gets the width of the generated pattern (2 dimensions).

Overrides:

getWidth in class AbstractGenerator

Returns:

the width, as a double.

getHeight

public double getHeight()

Description copied from class: AbstractGenerator

Gets the height of the generated pattern (2 dimensions).

Overrides:

getHeight in class AbstractGenerator

Returns:

the height, as a double.