org.opentrafficsim.graphs

Class AbstractOTSPlot

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

org.opentrafficsim.graphs.AbstractOTSPlot

All Implemented Interfaces:

ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants, org.jfree.data.general.Dataset, LaneBasedGTUSampler, MultipleViewerChart

Direct Known Subclasses:

ContourPlot, TrajectoryPlot

public abstract class AbstractOTSPlot
extends JFrame
implements org.jfree.data.general.Dataset, ActionListener, MultipleViewerChart, LaneBasedGTUSampler

Basics of all plots in the Open Traffic Simulator.

Copyright (c) 2013-2017 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

$Revision$, $LastChangedDate$, by $Author$, initial version Sep 16, 2016

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JFrame

JFrame.AccessibleJFrame

Nested classes/interfaces inherited from class java.awt.Frame

Frame.AccessibleAWTFrame

Nested classes/interfaces inherited from class java.awt.Window

Window.AccessibleAWTWindow, Window.Type

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static nl.tudelft.simulation.event.EventType	GRAPH_ADD_EVENT The (regular, not timed) event type for pub/sub indicating the addition of a graph.
static nl.tudelft.simulation.event.EventType	GRAPH_REMOVE_EVENT The (regular, not timed) event type for pub/sub indicating the removal of a graph.

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
AbstractOTSPlot(String caption, List<Lane> path) Construct a new AbstractOTSPlot.

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(org.jfree.data.general.DatasetChangeListener listener)
JFrame	addViewer() Create/add a viewer for the data of the graph.
protected abstract org.jfree.chart.JFreeChart	createChart(JFrame container) Create the visualization.
byte[]	generatePNG(int width, int height) Make a snapshot of the graph and return it encoded as a PNG image.
String	getCaption() Return the caption of this graph.
abstract GraphType	getGraphType() Return the graph type.
String	getId() Provide a unique ID for this graph.
protected EventListenerList	getListenerList()
nl.tudelft.simulation.immutablecollections.ImmutableList<Lane>	getPath()
protected void	notifyListeners(org.jfree.data.general.DatasetChangeEvent event) Notify interested parties of an event affecting this TrajectoryPlot.
abstract void	reGraph() Force redrawing of the graph.
void	removeChangeListener(org.jfree.data.general.DatasetChangeListener listener)
protected void	setChart(org.jfree.chart.JFreeChart chart) Save the chart.

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setBackground, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setOpacity, setResizable, setShape, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, setVisible, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jfree.data.general.Dataset

getGroup, setGroup

Methods inherited from interface java.awt.event.ActionListener

actionPerformed

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

GRAPH_ADD_EVENT

public static final nl.tudelft.simulation.event.EventType GRAPH_ADD_EVENT

The (regular, not timed) event type for pub/sub indicating the addition of a graph.
Payload: String graph caption (not an array, just a String)

GRAPH_REMOVE_EVENT

public static final nl.tudelft.simulation.event.EventType GRAPH_REMOVE_EVENT

The (regular, not timed) event type for pub/sub indicating the removal of a graph.
Payload: String Graph caption (not an array, just a String)

Constructor Detail

AbstractOTSPlot

public AbstractOTSPlot(String caption,
                       List<Lane> path)

Construct a new AbstractOTSPlot.

Parameters:

caption - String; the caption of the graph window

path - List<Lane> the lanes for which the plot is made

Method Detail

setChart

protected final void setChart(org.jfree.chart.JFreeChart chart)

Save the chart.

Parameters:

chart - JFreeChart; the chart

createChart

protected abstract org.jfree.chart.JFreeChart createChart(JFrame container)

Create the visualization.

Parameters:

container - JFrame; the JFrame that will be filled with chart and the status label

Returns:

JFreeChart; the visualization

reGraph

public abstract void reGraph()

Force redrawing of the graph.

Specified by:

reGraph in interface LaneBasedGTUSampler

addViewer

public final JFrame addViewer()

Create/add a viewer for the data of the graph.

Specified by:

addViewer in interface MultipleViewerChart

Returns:

JFrame; the JFrame that holds the visualization of the data

addChangeListener

public final void addChangeListener(org.jfree.data.general.DatasetChangeListener listener)

Specified by:

addChangeListener in interface org.jfree.data.general.Dataset

removeChangeListener

public final void removeChangeListener(org.jfree.data.general.DatasetChangeListener listener)

Specified by:

removeChangeListener in interface org.jfree.data.general.Dataset

notifyListeners

protected final void notifyListeners(org.jfree.data.general.DatasetChangeEvent event)

Notify interested parties of an event affecting this TrajectoryPlot.

Parameters:

event - DatasetChangedEvent

getListenerList

protected final EventListenerList getListenerList()

Returns:

listenerList.

getCaption

public final String getCaption()

Return the caption of this graph.

Returns:

String; the caption of this graph

getId

public final String getId()

Provide a unique ID for this graph. In this case based on a generated UUID.

Returns:

String; a unique ID.

getPath

public final nl.tudelft.simulation.immutablecollections.ImmutableList<Lane> getPath()

Returns:

path List<Lane> the path

getGraphType

public abstract GraphType getGraphType()

Return the graph type.

Returns:

GraphType: the graph type.

generatePNG

public final byte[] generatePNG(int width,
                                int height)
                         throws IOException

Make a snapshot of the graph and return it encoded as a PNG image.

Parameters:

width - int; the width of the PNG in pixels

height - int; the height of the PNG in pixels

Returns:

byte[]; the PNG encoded graph

Throws:

IOException - when there are IO