org.opentrafficsim.graphs

Class FundamentalDiagram

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Window

java.awt.Frame

javax.swing.JFrame

org.opentrafficsim.graphs.FundamentalDiagram

All Implemented Interfaces:

ActionListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, RootPaneContainer, WindowConstants, Dataset, SeriesDataset, XYDataset

public class FundamentalDiagram
extends JFrame
implements XYDataset, ActionListener, Serializable

The Fundamental Diagram Graph; see Wikipedia: http://en.wikipedia.org/wiki/Fundamental_diagram_of_traffic_flow.

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

$LastChangedDate: 2015-09-14 01:33:02 +0200 (Mon, 14 Sep 2015) $, @version $Revision: 1401 $, by $Author: averbraeck $, initial version Jul 31, 2014

Author:

Peter Knoppers

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 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
FundamentalDiagram(String caption, Duration aggregationTime, Lane lane, Length position, Compatible detectedGTUTypes, DEVSSimulatorInterface.TimeDoubleUnit simulator) Graph a Fundamental Diagram.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent actionEvent)
void	addChangeListener(DatasetChangeListener listener)
void	addData(LaneBasedGTU gtu) Add the effect of one passing car to this Fundamental Diagram.
Duration	getAggregationTime()
Axis	getDensityAxis()
DomainOrder	getDomainOrder()
Axis	getFlowAxis()
DatasetGroup	getGroup()
int	getItemCount(int series)
Length	getPosition() Retrieve the position of the detector.
int	getSeriesCount()
Comparable<Integer>	getSeriesKey(int series)
Axis	getSpeedAxis()
Number	getX(int series, int item)
String	getXAxisFormat() Retrieve the format string for the X axis.
double	getXValue(int series, int item)
Number	getY(int series, int item)
String	getYAxisFormat() Retrieve the format string for the Y axis.
double	getYValue(int series, int item)
int	indexOf(Comparable seriesKey)
void	reGraph() Redraw this TrajectoryGraph (after the underlying data has been changed, or to change axes).
void	removeChangeListener(DatasetChangeListener listener)
void	setGroup(DatasetGroup group)
void	setStatusText(String newText) Update the status text.
String	toString()

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, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Constructor Detail

FundamentalDiagram

public FundamentalDiagram(String caption,
                          Duration aggregationTime,
                          Lane lane,
                          Length position,
                          Compatible detectedGTUTypes,
                          DEVSSimulatorInterface.TimeDoubleUnit simulator)
                   throws NetworkException

Graph a Fundamental Diagram.

Parameters:

caption - String; the caption shown above the graphing area.

aggregationTime - DoubleScalarRel<TimeUnit>; the aggregation of the detector that generates the data for this Fundamental diagram

lane - Lane; the Lane on which the traffic will be sampled

position - DoubleScalarRel<LengthUnit>; longitudinal position of the detector on the Lane

detectedGTUTypes - Compatible; the types of GTU that will be used to compose this fundamental diagram

simulator - the simulator

Throws:

NetworkException - on network inconsistency

Method Detail

getAggregationTime

public final Duration getAggregationTime()

Returns:

aggregationTime

getDensityAxis

public final Axis getDensityAxis()

Returns:

densityAxis

getSpeedAxis

public final Axis getSpeedAxis()

Returns:

speedAxis

getFlowAxis

public final Axis getFlowAxis()

Returns:

flowAxis

getYAxisFormat

public final String getYAxisFormat()

Retrieve the format string for the Y axis.

Returns:

format string

getXAxisFormat

public final String getXAxisFormat()

Retrieve the format string for the X axis.

Returns:

format string

setStatusText

public final void setStatusText(String newText)

Update the status text.

Parameters:

newText - String; the new text to show

getPosition

public final Length getPosition()

Retrieve the position of the detector.

Returns:

Length; the position of the detector

addData

public final void addData(LaneBasedGTU gtu)
                   throws GTUException

Add the effect of one passing car to this Fundamental Diagram.

Parameters:

gtu - AbstractLaneBasedGTU; the GTU that passes the detection point

Throws:

GTUException - when the speed of the GTU cannot be assessed

reGraph

public final void reGraph()

Redraw this TrajectoryGraph (after the underlying data has been changed, or to change axes).

getSeriesCount

public final int getSeriesCount()

Specified by:

getSeriesCount in interface SeriesDataset

getSeriesKey

public final Comparable<Integer> getSeriesKey(int series)

Specified by:

getSeriesKey in interface SeriesDataset

indexOf

public final int indexOf(Comparable seriesKey)

Specified by:

indexOf in interface SeriesDataset

addChangeListener

public final void addChangeListener(DatasetChangeListener listener)

Specified by:

addChangeListener in interface Dataset

removeChangeListener

public final void removeChangeListener(DatasetChangeListener listener)

Specified by:

removeChangeListener in interface Dataset

getGroup

public final DatasetGroup getGroup()

Specified by:

getGroup in interface Dataset

setGroup

public final void setGroup(DatasetGroup group)

Specified by:

setGroup in interface Dataset

getDomainOrder

public final DomainOrder getDomainOrder()

Specified by:

getDomainOrder in interface XYDataset

getItemCount

public final int getItemCount(int series)

Specified by:

getItemCount in interface XYDataset

getX

public final Number getX(int series,
                         int item)

Specified by:

getX in interface XYDataset

getXValue

public final double getXValue(int series,
                              int item)

Specified by:

getXValue in interface XYDataset

getY

public final Number getY(int series,
                         int item)

Specified by:

getY in interface XYDataset

getYValue

public final double getYValue(int series,
                              int item)

Specified by:

getYValue in interface XYDataset

toString

public final String toString()

Overrides:

toString in class Component

actionPerformed

public final void actionPerformed(ActionEvent actionEvent)

Specified by:

actionPerformed in interface ActionListener