io.jbotsim.gen.basic.generators

Class LineGenerator

java.lang.Object

io.jbotsim.gen.basic.generators.AbstractGenerator

io.jbotsim.gen.basic.generators.LineGenerator

All Implemented Interfaces:

TopologyGenerator

public class LineGenerator
extends AbstractGenerator

The LineGenerator is a TopologyGenerator used to create horizontal or vertical lines.

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
LineGenerator(int nbNodes, int size) Creates a LineGenerator creating an horizontal line of size size with nbNodes Nodes.
LineGenerator(int nbNodes, int size, boolean horizontal) Creates a LineGenerator creating a line of size size with nbNodes Nodes.

Method Summary

Modifier and Type	Method and Description
void	generate(Topology topology) Modifies the provided Topology according to the implementation.
int	getNbNodes() Gets the number of Nodes which should be created (1-dimension).
double	getSize() Gets the one-dimension size of the generated pattern.
boolean	isHorizontal() Returns true if the line should be horizontal, false otherwise.
LineGenerator	setHorizontal(boolean horizontal) Sets the orientation state of the line.
LineGenerator	setNbNodes(java.lang.Object dimensionIndex, int nbNodes) Sets the number of Nodes which should be created in an arbitrary dimension.
LineGenerator	setSize(double size) Sets the one-direction size of the generated pattern.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

LineGenerator

public LineGenerator(int nbNodes,
                     int size)

Creates a LineGenerator creating an horizontal line of size size with nbNodes Nodes.

Parameters:

nbNodes - the number of Nodes to be added.

size - the size of the line

LineGenerator

public LineGenerator(int nbNodes,
                     int size,
                     boolean horizontal)

Creates a LineGenerator creating a line of size size with nbNodes Nodes. The line orientation depends on the horizontal parameter.

Parameters:

nbNodes - the number of Nodes to be added.

size - the size of the line

horizontal - true if the line should be horizontal, false if it should be vertical.

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

setHorizontal

public LineGenerator setHorizontal(boolean horizontal)

Sets the orientation state of the line.

Parameters:

horizontal - true if the line should be horizontal, false otherwise.

Returns:

a reference to the object.

isHorizontal

public boolean isHorizontal()

Returns true if the line should be horizontal, false otherwise.

Returns:

true if the line should be horizontal, false otherwise.

getSize

public double getSize()

Description copied from class: AbstractGenerator

Gets the one-dimension size of the generated pattern.

Overrides:

getSize in class AbstractGenerator

Returns:

the size, as a double.

setSize

public LineGenerator setSize(double size)

Description copied from class: AbstractGenerator

Sets the one-direction size of the generated pattern.

Overrides:

setSize in class AbstractGenerator

Parameters:

size - the double representing of the generated pattern, as a double.

Returns:

a reference to the object.

setNbNodes

public LineGenerator setNbNodes(java.lang.Object dimensionIndex,
                                int nbNodes)

Description copied from class: AbstractGenerator

Sets the number of Nodes which should be created in an arbitrary dimension.

Overrides:

setNbNodes in class AbstractGenerator

Parameters:

dimensionIndex - the dimension index; can be any type of object.

nbNodes - the number of Node to be created.

Returns:

a reference to the object.

getNbNodes

public int getNbNodes()

Description copied from class: AbstractGenerator

Gets the number of Nodes which should be created (1-dimension).

Overrides:

getNbNodes in class AbstractGenerator

Returns:

the number of Node to be created.