io.jbotsim.gen.basic.generators

Class AbstractGenerator

java.lang.Object

io.jbotsim.gen.basic.generators.AbstractGenerator

All Implemented Interfaces:

TopologyGenerator

Direct Known Subclasses:

GridGenerator, LineGenerator, RandomLocationsGenerator, RingGenerator

public abstract class AbstractGenerator
extends Object
implements TopologyGenerator

The AbstractGenerator holds common fields and methods for the different implementations of the TopologyGenerator interface.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	absoluteCoords
protected Map<Object,Double>	dimensionsMap
protected boolean	directed
protected static int	FIRST_DIMENSION_INDEX
protected Map<Object,Integer>	nbNodesMap
protected Class<? extends Node>	nodeClass
protected static int	SECOND_DIMENSION_INDEX
protected boolean	wired
protected boolean	wirelessEnabled
protected double	x
protected double	y

Constructor Summary

Constructors

Constructor and Description
AbstractGenerator()

Method Summary

Modifier and Type	Method and Description
protected Node	addNodeAtLocation(Topology tp, double x0, double y0, double cr)
protected double	getAbsoluteHeight(Topology tp) Gets the absolute height of the generated pattern (2 dimensions).
protected double	getAbsoluteWidth(Topology tp) Gets the absolute width of the generated pattern (2 dimensions).
double	getAbsoluteX(Topology tp) Returns the absolute X coordinate, depending on getX() and isAbsoluteCoords().
double	getAbsoluteY(Topology tp) Returns the absolute Y coordinate, depending on getY() and isAbsoluteCoords().
protected double	getDimension(Object dimensionIndex) Gets the size of the generated pattern for the provided dimension.
protected double	getHeight() Gets the height of the generated pattern (2 dimensions).
protected int	getNbNodes() Gets the number of Nodes which should be created (1-dimension).
protected int	getNbNodes(Object dimensionIndex) Gets the number of Nodes which should be created in an arbitrary dimension.
Class<? extends Node>	getNodeClass() Gets the Class object with which Nodes should be instantiated.
protected double	getSize() Gets the one-dimension size of the generated pattern.
protected double	getWidth() Gets the width of the generated pattern (2 dimensions).
double	getX() Gets the X coordinate.
double	getY() Gets the Y coordinate.
boolean	isAbsoluteCoords() Returns the absolute coordinates state.
boolean	isDirected() Returns true if the graph should be directed; false otherwise.
boolean	isWired() Returns true if the links should be wired; false otherwise.
boolean	isWirelessEnabled() Returns true if the wireless links should be enabled; false otherwise.
AbstractGenerator	setAbsoluteCoords(boolean absoluteCoords) Sets the absolute coordinates state.
protected void	setDefaultWidthHeight()
protected AbstractGenerator	setDimension(Object dimensionIndex, double value) Sets the size of the generated pattern for an arbitrary dimension.
AbstractGenerator	setDirected(boolean directed) Sets the graph direction state.
protected AbstractGenerator	setHeight(double height) Sets the height of the generated pattern (2 dimensions).
protected AbstractGenerator	setNbNodes(int nbNodes) Sets the number of Nodes which should be created (1-dimension).
protected AbstractGenerator	setNbNodes(Object dimensionIndex, int nbNodes) Sets the number of Nodes which should be created in an arbitrary dimension.
AbstractGenerator	setNodeClass(Class<? extends Node> nodeClass) Sets the Class object with which Nodes should be instantiated.
protected AbstractGenerator	setSize(double size) Sets the one-direction size of the generated pattern.
protected AbstractGenerator	setWidth(double width) Sets the width of the generated pattern (2 dimensions).
AbstractGenerator	setWired(boolean wired) Sets the links' wiring state.
AbstractGenerator	setWirelessEnabled(boolean wirelessEnabled) Sets the links' wireless state.
AbstractGenerator	setX(double x) Sets the X coordinate.
AbstractGenerator	setY(double y) Sets the Y coordinate.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jbotsim.gen.basic.generators.TopologyGenerator

generate

Field Detail

FIRST_DIMENSION_INDEX

protected static final int FIRST_DIMENSION_INDEX

See Also:

Constant Field Values

SECOND_DIMENSION_INDEX

protected static final int SECOND_DIMENSION_INDEX

See Also:

Constant Field Values

dimensionsMap

protected Map<Object,Double> dimensionsMap

directed

protected boolean directed

wired

protected boolean wired

wirelessEnabled

protected boolean wirelessEnabled

x

protected double x

y

protected double y

nbNodesMap

protected Map<Object,Integer> nbNodesMap

nodeClass

protected Class<? extends Node> nodeClass

absoluteCoords

protected boolean absoluteCoords

Constructor Detail

AbstractGenerator

public AbstractGenerator()

Method Detail

isAbsoluteCoords

public boolean isAbsoluteCoords()

Returns the absolute coordinates state. Namely:

• true if the provided coordinates are meant to be absolute
• false if the provided coordinates are meant to be in [0:1]

Returns:

the absolute coordinates.

setAbsoluteCoords

public AbstractGenerator setAbsoluteCoords(boolean absoluteCoords)

Sets the absolute coordinates state. Namely:

• true if the provided coordinates are meant to be absolute
• false if the provided coordinates are meant to be in [0:1]

Parameters:

absoluteCoords - the new absolute coordinates state.

Returns:

a reference to the object.

isDirected

public boolean isDirected()

Returns true if the graph should be directed; false otherwise.

Returns:

true if the graph should be directed; false otherwise.

setDirected

public AbstractGenerator setDirected(boolean directed)

Sets the graph direction state.

Parameters:

directed - true if the graph should be directed; false otherwise.

Returns:

a reference to the object.

isWired

public boolean isWired()

Returns true if the links should be wired; false otherwise.

Returns:

true if the links should be wired; false otherwise.

setWired

public AbstractGenerator setWired(boolean wired)

Sets the links' wiring state.

Parameters:

wired - true if the links should be wired; false otherwise.

Returns:

a reference to the object.

isWirelessEnabled

public boolean isWirelessEnabled()

Returns true if the wireless links should be enabled; false otherwise.

Returns:

true if the wireless links should be enabled; false otherwise.

setWirelessEnabled

public AbstractGenerator setWirelessEnabled(boolean wirelessEnabled)

Sets the links' wireless state.

Parameters:

wirelessEnabled - true if the wireless links should be enabled; false otherwise.

Returns:

a reference to the object.

getX

public double getX()

Gets the X coordinate.

Returns:

the X coordinate, as a double.

setX

public AbstractGenerator setX(double x)

Sets the X coordinate.

Parameters:

x - the X coordinate, as a double.

Returns:

a reference to the object.

getAbsoluteX

public double getAbsoluteX(Topology tp)

Returns the absolute X coordinate, depending on getX() and isAbsoluteCoords().

Parameters:

tp - the related Topology object

Returns:

the absolute X coordinate, as a double.

getY

public double getY()

Gets the Y coordinate.

Returns:

the Y coordinate, as a double.

setY

public AbstractGenerator setY(double y)

Sets the Y coordinate.

Parameters:

y - the Y coordinate, as a double.

Returns:

a reference to the object.

getAbsoluteY

public double getAbsoluteY(Topology tp)

Returns the absolute Y coordinate, depending on getY() and isAbsoluteCoords().

Parameters:

tp - the related Topology object

Returns:

the absolute Y coordinate, as a double.

setDimension

protected AbstractGenerator setDimension(Object dimensionIndex,
                                         double value)

Sets the size of the generated pattern for an arbitrary dimension.

Parameters:

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

value - the value of the provided dimension.

Returns:

a reference to the object.

getDimension

protected double getDimension(Object dimensionIndex)

Gets the size of the generated pattern for the provided dimension.

Parameters:

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

Returns:

the size of the pattern for the provided dimension.

getWidth

protected double getWidth()

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

Returns:

the width, as a double.

setWidth

protected AbstractGenerator setWidth(double width)

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

Parameters:

width - the desired width, as a double.

Returns:

a reference to the object.

getAbsoluteWidth

protected double getAbsoluteWidth(Topology tp)

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

Parameters:

tp - the related Topology object

Returns:

the absolute width of the generated pattern

getHeight

protected double getHeight()

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

Returns:

the height, as a double.

setHeight

protected AbstractGenerator setHeight(double height)

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

Parameters:

height - the desired height, as a double.

Returns:

a reference to the object.

getAbsoluteHeight

protected double getAbsoluteHeight(Topology tp)

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

Parameters:

tp - the related Topology object

Returns:

the absolute height of the generated pattern

setDefaultWidthHeight

protected void setDefaultWidthHeight()

getSize

protected double getSize()

Gets the one-dimension size of the generated pattern.

Returns:

the size, as a double.

setSize

protected AbstractGenerator setSize(double size)

Sets the one-direction size of the generated pattern.

Parameters:

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

Returns:

a reference to the object.

getNodeClass

public Class<? extends Node> getNodeClass()

Gets the Class object with which Nodes should be instantiated.

Returns:

the instantiated Node type.

setNodeClass

public AbstractGenerator setNodeClass(Class<? extends Node> nodeClass)

Sets the Class object with which Nodes should be instantiated.

Parameters:

nodeClass - the instantiated Node type.

Returns:

a reference to the object.

setNbNodes

protected AbstractGenerator setNbNodes(Object dimensionIndex,
                                       int nbNodes)

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

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

protected int getNbNodes(Object dimensionIndex)

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

Parameters:

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

Returns:

the number of Node to be created.

getNbNodes

protected int getNbNodes()

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

Returns:

the number of Node to be created.

setNbNodes

protected AbstractGenerator setNbNodes(int nbNodes)

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

Parameters:

nbNodes - the number of Node to be created.

Returns:

a reference to the object.

addNodeAtLocation

protected Node addNodeAtLocation(Topology tp,
                                 double x0,
                                 double y0,
                                 double cr)
                          throws InstantiationException,
                                 IllegalAccessException,
                                 InvocationTargetException,
                                 NoSuchMethodException

Throws:

InstantiationException

IllegalAccessException

InvocationTargetException

NoSuchMethodException