desmoj.extensions.experimentation.ui

Class HistogramPlotter

java.lang.Object

desmoj.extensions.experimentation.ui.GraphicalObserver

desmoj.extensions.experimentation.ui.HistogramPlotter

All Implemented Interfaces:

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

public class HistogramPlotter
extends GraphicalObserver
implements ExperimentListener, ChartOwner

A simple histogram plotter based on the statistic class Histogram and the UI class ChartPanel.

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.

Constructor Summary

Constructors

Constructor and Description
HistogramPlotter(java.lang.String title, GraphicalObserverContext context, Histogram data, java.lang.String xUnit, int winWidth, int winHeight) Creates a new HistogramPlotter
HistogramPlotter(java.lang.String title, GraphicalObserverContext context, Histogram data, java.lang.String xUnit, int winWidth, int winHeight, int x, int y) Creates a new HistogramPlotter

Method Summary

Modifier and Type	Method and Description
void	drawChart(java.awt.Graphics g) Draws the histogram bars given by the Histogram statistic object into the chart.
void	experimentPaused(SimRunEvent e) Called when experiment is paused.
void	experimentRunning(SimRunEvent e) Called when experiment is (re)started.
void	experimentStopped(SimRunEvent e) Called when experiment is stopped.
java.awt.Component	getGUI() Should return the graphical observer's main GUI component

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

HistogramPlotter

public HistogramPlotter(java.lang.String title,
                        GraphicalObserverContext context,
                        Histogram data,
                        java.lang.String xUnit,
                        int winWidth,
                        int winHeight)

Creates a new HistogramPlotter

Parameters:

name - name displayed in window title

context - graphical observer context the plotter is displayed in

data - HistogramData consisting of double values to be displayed in the histogram

xUnit - unit label for x axis

winWidth - width of window

winHeight - height of window

HistogramPlotter

public HistogramPlotter(java.lang.String title,
                        GraphicalObserverContext context,
                        Histogram data,
                        java.lang.String xUnit,
                        int winWidth,
                        int winHeight,
                        int x,
                        int y)

Creates a new HistogramPlotter

Parameters:

name - name displayed in window title

context - graphical observer context the plotter is displayed in

data - HistogramData consisting of double values to be displayed in the histogram

xUnit - unit label for x axis

winWidth - width of window

winHeight - height of window

x - horizontal window location

y - vertical window location

Method Detail

getGUI

public java.awt.Component getGUI()

Description copied from interface: IGraphicalObserver

Should return the graphical observer's main GUI component

Specified by:

getGUI in interface IGraphicalObserver

Specified by:

getGUI in class GraphicalObserver

Returns:

The GUI component of this observer (a jfree.org.chart.ChartPanel).

See Also:

GraphicalObserver.getGUI()

experimentRunning

public void experimentRunning(SimRunEvent e)

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

Specified by:

experimentRunning in interface ExperimentListener

Parameters:

e - a SimRunEvent

See Also:

desmoj.extensions.experimentation.access.ExperimentListener#experimentRunning(SimRunEvent)

experimentStopped

public void experimentStopped(SimRunEvent e)

Called when experiment is stopped. HistogramData is displayed in chart.

Specified by:

experimentStopped in interface ExperimentListener

Parameters:

e - a SimRunEvent

See Also:

desmoj.extensions.experimentation.access.ExperimentListener#experimentStopped(SimRunEvent)

experimentPaused

public void experimentPaused(SimRunEvent e)

Called when experiment is paused. Current HistogramData is displayed in chart until restarting the simulation.

Specified by:

experimentPaused in interface ExperimentListener

Parameters:

e - a SimRunEvent

See Also:

desmoj.extensions.experimentation.access.ExperimentListener#experimentPaused(SimRunEvent)

drawChart

public void drawChart(java.awt.Graphics g)

Draws the histogram bars given by the Histogram 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.