io.jbotsim.io.format.tikz

Class TikzTopologySerializer

java.lang.Object

io.jbotsim.io.format.tikz.TikzTopologySerializer

All Implemented Interfaces:

TopologySerializer

public class TikzTopologySerializer
extends Object
implements TopologySerializer

The TikzTopologySerializer exports a JBotSim Topology into TikZ format.

Note: importFromString(Topology, String) is not supported.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_EOL The default End-Of-Line delimiter.
static double	DEFAULT_SCALE_FACTOR The default scale factor that must be applied to the distance between nodes.
protected String	eol
protected double	scaleFactor

Constructor Summary

Constructors

Constructor and Description
TikzTopologySerializer() Creates TikzTopologySerializer with the default values.
TikzTopologySerializer(String eol, double scaleFactor) Creates A TikzTopologySerializer according to the provided parameters.

Method Summary

Modifier and Type	Method and Description
protected String	exportTopology(Topology topology, double scaleFactor)
String	exportToString(Topology topology) Returns a string representation of this topology.
static String	getTikzStringColor(Color color) Converts a JBotSim Color into a color string displayable with TikZ.
void	importFromString(Topology topology, String data) Imports nodes and wired links from the specified string representation of a topology.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_EOL

public static final String DEFAULT_EOL

The default End-Of-Line delimiter.

See Also:

Constant Field Values

DEFAULT_SCALE_FACTOR

public static final double DEFAULT_SCALE_FACTOR

The default scale factor that must be applied to the distance between nodes.

See Also:

Constant Field Values

eol

protected String eol

scaleFactor

protected double scaleFactor

Constructor Detail

TikzTopologySerializer

public TikzTopologySerializer()

Creates TikzTopologySerializer with the default values.

See Also:

DEFAULT_EOL, DEFAULT_SCALE_FACTOR

TikzTopologySerializer

public TikzTopologySerializer(String eol,
                              double scaleFactor)

Creates A TikzTopologySerializer according to the provided parameters.

Parameters:

eol - The String to append at the end of each line.

scaleFactor - The scale factor to apply to each Node location, as a double.

See Also:

DEFAULT_EOL, DEFAULT_SCALE_FACTOR

Method Detail

getTikzStringColor

public static String getTikzStringColor(Color color)

Converts a JBotSim Color into a color string displayable with TikZ.

Parameters:

color - a Color to be converter

Returns:

a TikZ-displayable equivalent of the provided color.

importFromString

public void importFromString(Topology topology,
                             String data)

Description copied from interface: TopologySerializer

Imports nodes and wired links from the specified string representation of a topology.

Specified by:

importFromString in interface TopologySerializer

Parameters:

topology - The Topology object which must be populated

data - The String representation.

exportToString

public String exportToString(Topology topology)

Description copied from interface: TopologySerializer

Returns a string representation of this topology. The output of this method can be subsequently used to reconstruct a topology with the TopologySerializer.importFromString(Topology, String) method. Only the nodes and wired links are exported here (not the topology's properties).

Specified by:

exportToString in interface TopologySerializer

Parameters:

topology - The Topology object which must be exported

Returns:

the String representation of the Topology

exportTopology

protected String exportTopology(Topology topology,
                                double scaleFactor)