jas.graphics.plot
Class TimeSeriesPlotter

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Frame
                  javax.swing.JFrame
                      ptolemy.plot.PlotFrame
                          jas.graphics.plot.TimeSeriesPlotter

All Implemented Interfaces:

ISimEventListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants

public class TimeSeriesPlotter
extends ptolemy.plot.PlotFrame
implements ISimEventListener

A time series plotter is able to trace one or more data sources over time. It is based on Ptolemy Plot plotter and uses data sources based on the jas.statistics.* interfaces.

Title: JAS

Description: Java Agent-based Simulation library

Copyright (C) 2002 Michele Sonnessa

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.

Author:

Michele Sonnessa

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.swing.JFrame

EXIT_ON_CLOSE

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

TimeSeriesPlotter()
Create a new time plotter with no title.

TimeSeriesPlotter(java.lang.String title)
Create a new time plotter with a given title.

Method Summary

void	addSeries(java.lang.String legend, IDoubleSource plottableObject) Build a series retrieving data from a IDoubleSource object, using the default variableId.
void	addSeries(java.lang.String legend, IDoubleSource plottableObject, int variableID) Build a series retrieving data from a IDoubleSource object.
void	addSeries(java.lang.String legend, IFloatSource plottableObject) Build a series from a IFloatSource object, using the default variableId.
void	addSeries(java.lang.String legend, IFloatSource plottableObject, int variableID) Build a series from a IFloatSource object.
void	addSeries(java.lang.String legend, IIntSource plottableObject) Build a series from a IIntSource object, using the default variableId.
void	addSeries(java.lang.String legend, IIntSource plottableObject, int variableID) Build a series from a IIntSource object.
void	addSeries(java.lang.String legend, ILongSource plottableObject) Build a series from a ILongSource object, using the default variableId.
void	addSeries(java.lang.String legend, ILongSource plottableObject, int variableID) Build a series from a ILongSource object.
void	addSeries(java.lang.String legend, java.lang.Object target, java.lang.String variableName, boolean getFromMethod) Build a series from a generic object.
java.lang.String	exportSVG()
void	exportSVGToFile(java.lang.String fileName)
ptolemy.plot.Plot	getPlot() Return the inner Plot object.
void	performAction(int actionType) Update the plot.
void	setBackEraseLength(int backErase) Force the plotter to erase the oldest data.
void	setDataWindow(int window) Force the plotter to display a fixed number of data on the visible field.
void	update() Refresh the plot.

Methods inherited from class ptolemy.plot.PlotFrame

samplePlot

Methods inherited from class javax.swing.JFrame

getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, isDefaultLookAndFeelDecorated, remove, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, update

Methods inherited from class java.awt.Frame

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

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getMostRecentFocusOwner, getOwnedWindows, getOwner, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, postEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, setAlwaysOnTop, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setLocationByPlatform, setLocationRelativeTo, 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, paint, paintComponents, preferredSize, print, printComponents, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, 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, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Constructor Detail

TimeSeriesPlotter

public TimeSeriesPlotter()

Create a new time plotter with no title.

TimeSeriesPlotter

public TimeSeriesPlotter(java.lang.String title)

Create a new time plotter with a given title.

Parameters:

title - The title of the frame.

Method Detail

addSeries

public void addSeries(java.lang.String legend,
                      IDoubleSource plottableObject)

Build a series retrieving data from a IDoubleSource object, using the default variableId.

Parameters:

legend - The legend name of the series.

plottableObject - The data source object implementing the IDoubleSource interface.

addSeries

public void addSeries(java.lang.String legend,
                      IDoubleSource plottableObject,
                      int variableID)

Build a series retrieving data from a IDoubleSource object.

Parameters:

legend - The legend name of the series.

plottableObject - The data source object implementing the IDoubleSource interface.

variableID - The variable id of the source object.

addSeries

public void addSeries(java.lang.String legend,
                      IFloatSource plottableObject)

Build a series from a IFloatSource object, using the default variableId.

Parameters:

legend - The legend name of the series.

plottableObject - The data source object implementing the IFloatSource interface.

addSeries

public void addSeries(java.lang.String legend,
                      IFloatSource plottableObject,
                      int variableID)

Build a series from a IFloatSource object.

Parameters:

legend - The legend name of the series.

plottableObject - The data source object implementing the IFloatSource interface.

variableID - The variable id of the source object.

addSeries

public void addSeries(java.lang.String legend,
                      IIntSource plottableObject)

Build a series from a IIntSource object, using the default variableId.

Parameters:

legend - The legend name of the series.

plottableObject - The data source object implementing the IIntSource interface.

addSeries

public void addSeries(java.lang.String legend,
                      IIntSource plottableObject,
                      int variableID)

Build a series from a IIntSource object.

Parameters:

legend - The legend name of the series.

plottableObject - The data source object implementing the IIntSource interface.

variableID - The variable id of the source object.

addSeries

public void addSeries(java.lang.String legend,
                      ILongSource plottableObject)

Build a series from a ILongSource object, using the default variableId.

Parameters:

legend - The legend name of the series.

plottableObject - The data source object implementing the ILongSource interface.

addSeries

public void addSeries(java.lang.String legend,
                      ILongSource plottableObject,
                      int variableID)

Build a series from a ILongSource object.

Parameters:

legend - The legend name of the series.

plottableObject - The data source object implementing the IDblSource interface.

variableID - The variable id of the source object.

addSeries

public void addSeries(java.lang.String legend,
                      java.lang.Object target,
                      java.lang.String variableName,
                      boolean getFromMethod)

Build a series from a generic object.

Parameters:

legend - The legend name of the series.

target - The data source object.

variableName - The variable or method name of the source object.

getFromMethod - Specifies if the variableName is a field or a method.

exportSVG

public java.lang.String exportSVG()

exportSVGToFile

public void exportSVGToFile(java.lang.String fileName)

getPlot

public ptolemy.plot.Plot getPlot()

Return the inner Plot object.

Returns:

The Ptolemy Plot engine.

performAction

public void performAction(int actionType)

Update the plot.

Specified by:

performAction in interface ISimEventListener

Parameters:

actionType - It is ignored. The only implemented action is update.

setBackEraseLength

public void setBackEraseLength(int backErase)

Force the plotter to erase the oldest data. When the simulation runs for a long time it could be necessary to empty some of the used memory.

Parameters:

backErase - Destroy all the data before the last backErase entries.

setDataWindow

public void setDataWindow(int window)

Force the plotter to display a fixed number of data on the visible field. The window contains the last [window] entries.

Parameters:

window - The length of the data window.

update

public void update()

Refresh the plot.