desmoj.extensions.experimentation.ui

Class TimeSeriesPlotter

java.lang.Object

desmoj.extensions.experimentation.ui.GraphicalObserver

desmoj.extensions.experimentation.ui.TimeSeriesPlotter

All Implemented Interfaces:

ExperimentListener, SimRunListener, ChartOwner, IGraphicalObserver, java.util.EventListener, java.util.Observer

public class TimeSeriesPlotter
extends GraphicalObserver
implements ExperimentListener, ChartOwner, java.util.Observer

A simple time series plotter that can be displayed in the experiment launcher.

Version:

DESMO-J, Ver. 2.5.1c copyright (c) 2015

Author:

Nicolas Knaak, Philip Joschko Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TimeSeriesPlotter.SimpleTimeSeriesViewer A simple means of drawing a TimeSeries without requiring the experimentation GUI by adding a TimeSeriesPlotter to an otherwise empty Frame.

Constructor Summary

Constructors

Constructor and Description
TimeSeriesPlotter(java.lang.String title, GraphicalObserverContext context, TimeSeries[] data, int winWidth, int winHeight) Creates a new TimeSeries plotter from the given array of TimeSeries objects.
TimeSeriesPlotter(java.lang.String title, GraphicalObserverContext context, TimeSeries[] data, int winWidth, int winHeight, int xLocation, int yLocation) Creates a new TimeSeries plotter from the given array of TimeSeries objects.
TimeSeriesPlotter(java.lang.String title, GraphicalObserverContext context, TimeSeries data, int winWidth, int winHeight) Creates a new TimeSeries plotter from the given TimeSeries object.
TimeSeriesPlotter(java.lang.String title, GraphicalObserverContext context, TimeSeries data, int winWidth, int winHeight, int xLocation, int yLocation) Creates a new TimeSeries plotter from the given TimeSeries object.
TimeSeriesPlotter(java.lang.String title, GraphicalObserverContext context, TimeSeries data, int winWidth, int winHeight, java.lang.String legend) Creates a new TimeSeries plotter from the given TimeSeries object.

Method Summary

Modifier and Type	Method and Description
void	addTimeSeries(TimeSeries newData) Adds another TimeSeries statistic object which will be displayed in the chart, using a default legend entry.
void	addTimeSeries(TimeSeries newData, java.lang.String legend) Adds another TimeSeries statistic object which will be displayed in the chart.
void	drawChart(java.awt.Graphics g) Draws the values given by the TimeSeries statistic object into the chart.
void	experimentPaused(SimRunEvent e) Called when the experiment is paused.
void	experimentRunning(SimRunEvent e) Called when the experiment is (re)started.
void	experimentStopped(SimRunEvent e) Called when the experiment is stopped.
java.awt.Component	getGUI() Returns the plotter's GUI (a JFreeCHartPanel)
void	update(java.util.Observable x, java.lang.Object y) The update method (required by interface 'Observer') will be called, if the TimeSeries produces new values.
void	updatePlotter() This method updates the chart.

Methods inherited from class desmoj.extensions.experimentation.ui.GraphicalObserver

deregister, getContext, getName, register, setLocation, setSize, setVisible, update

Methods inherited from class java.lang.Object

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

Constructor Detail

TimeSeriesPlotter

public TimeSeriesPlotter(java.lang.String title,
                         GraphicalObserverContext context,
                         TimeSeries[] data,
                         int winWidth,
                         int winHeight)

Creates a new TimeSeries plotter from the given array of TimeSeries objects.

Parameters:

title - window title

context - the context to show this observer in

data - array of TimeSeries data to display

winWidth - width of window

winHeight - height of window

TimeSeriesPlotter

public TimeSeriesPlotter(java.lang.String title,
                         GraphicalObserverContext context,
                         TimeSeries data,
                         int winWidth,
                         int winHeight)

Creates a new TimeSeries plotter from the given TimeSeries object. This is the main constructor. The other constructors finally call this one.

Parameters:

title - window title

context - the context to show this observer in

data - TimeSeries to display

winWidth - width of window

winHeight - height of window

TimeSeriesPlotter

public TimeSeriesPlotter(java.lang.String title,
                         GraphicalObserverContext context,
                         TimeSeries data,
                         int winWidth,
                         int winHeight,
                         java.lang.String legend)

Creates a new TimeSeries plotter from the given TimeSeries object. This is the main constructor. The other constructors finally call this one.

Parameters:

title - window title

context - the context to show this observer in

data - TimeSeries to display

winWidth - width of window

winHeight - height of window

String - legend (only used if further plots are added to this plotter)

TimeSeriesPlotter

public TimeSeriesPlotter(java.lang.String title,
                         GraphicalObserverContext context,
                         TimeSeries data,
                         int winWidth,
                         int winHeight,
                         int xLocation,
                         int yLocation)

Creates a new TimeSeries plotter from the given TimeSeries object.

Parameters:

title - window title

context - the context to show this observer in

data - data of time series to display

winWidth - width of window

winHeight - height of window

xLocation - horizontal position of window

yLocation - vertical position of window

TimeSeriesPlotter

public TimeSeriesPlotter(java.lang.String title,
                         GraphicalObserverContext context,
                         TimeSeries[] data,
                         int winWidth,
                         int winHeight,
                         int xLocation,
                         int yLocation)

Creates a new TimeSeries plotter from the given array of TimeSeries objects.

Parameters:

title - window title

context - the context to show this observer in

data - data of time series to display

winWidth - width of window

winHeight - height of window

xLocation - horizontal position of window

yLocation - vertical position of window

Method Detail

addTimeSeries

public void addTimeSeries(TimeSeries newData)

Adds another TimeSeries statistic object which will be displayed in the chart, using a default legend entry.

Parameters:

newData - Another TimeSeries statistic object which will be displayed in the chart.

addTimeSeries

public void addTimeSeries(TimeSeries newData,
                          java.lang.String legend)

Adds another TimeSeries statistic object which will be displayed in the chart.

Parameters:

newData - Another TimeSeries statistic object which will be displayed in the chart.

legend - A short description. *

getGUI

public java.awt.Component getGUI()

Returns the plotter's GUI (a JFreeCHartPanel)

Specified by:

getGUI in interface IGraphicalObserver

Specified by:

getGUI in class GraphicalObserver

Returns:

a JFreeChart panel to plot the time series

experimentRunning

public void experimentRunning(SimRunEvent e)

Called when the experiment is (re)started. Nothing happens

Specified by:

experimentRunning in interface ExperimentListener

Parameters:

e - a SimRunEvent

experimentStopped

public void experimentStopped(SimRunEvent e)

Called when the experiment is stopped. Update of display

Specified by:

experimentStopped in interface ExperimentListener

Parameters:

e - a SimRunEvent

experimentPaused

public void experimentPaused(SimRunEvent e)

Called when the experiment is paused. Update of display

Specified by:

experimentPaused in interface ExperimentListener

Parameters:

e - a SimRunEvent

drawChart

public void drawChart(java.awt.Graphics g)

Draws the values given by the TimeSeries statistic object into the chart. This method is automatically invoked by the chart object, if it has to repaint.

Specified by:

drawChart in interface ChartOwner

Parameters:

g - The specified Graphics object.

update

public void update(java.util.Observable x,
                   java.lang.Object y)

The update method (required by interface 'Observer') will be called, if the TimeSeries produces new values.

Specified by:

update in interface java.util.Observer

updatePlotter

public void updatePlotter()

This method updates the chart. The chart will only be repainted if a new scaling is required. If no rescaling is required, then only the new values are painted. Of course this is much faster. Because the TimeSeriesPlotter has no bench marks for scaling at the beginning, you have to call this method at least one time, when the upper and lower limits are known.