desmoj.core.report

Class HistogramReporter

java.lang.Object

desmoj.core.report.Reporter

desmoj.core.report.HistogramReporter

public class HistogramReporter
extends Reporter

Captures all relevant information about the Histogram. Extended to show unit and description of reported object.

Version:

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

Author:

Soenke Claassen based on ideas from Tim Lechler, based on DESMO-C from Thomas Schniewind, 1998, edited by Gunnar Kiesel (setting noOfCells at breakpoint), modified by Chr. Müller (TH Wildau) 28.11.2012 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
HistogramReporter(Reportable informationSource) Constructor for a new HistogramReporter.

Method Summary

Modifier and Type	Method and Description
ChartDataHistogramLong	getChartData() Returns the data for the histogram chart.
java.lang.String[]	getEntries() Returns an array of Strings each containing the data for the corresponding column in array columns[].
java.lang.String[]	getHistColumnTitles() Returns an array of Strings each containing the title for the corresponding column of the histogram part (table).
java.lang.String[][]	getHistEntries() Returns a two-dimensional array of Strings containing the data for the histogram part of this HistogramReporter.
int	getHistNumColumns() Returns the number of columns of the histogram part (table) of this HistogramReporter.
int	getNoOfCells() Returns the number of cells the interval of the given Histogram is devided into.
long	getObservations() Returns the number of observations made by the Histogram object.
boolean	isContinuingReporter()

Methods inherited from class desmoj.core.report.Reporter

getColumnTitles, getDescription, getGroupID, getHeading, getModel, getNumOfSlaveQueues, getReportable, isEqual, isLarger, isOtherGroup, isSameGroup, isTwoRowReporter, makeAdditionalColorEntryIfHTMLColorChartIsGenerated, numColumns

Methods inherited from class java.lang.Object

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

Constructor Detail

HistogramReporter

public HistogramReporter(Reportable informationSource)

Constructor for a new HistogramReporter. Note that although any Reportable is accepted you should make sure that only subtypes of Histogram are passed to this constructor. Otherwise the number of column titles and their individual headings will differ from the actual content collected by this reporter.

Parameters:

informationSource - desmoj.core.simulator.Reportable : The Histogram to report about.

Method Detail

getEntries

public java.lang.String[] getEntries()

Returns an array of Strings each containing the data for the corresponding column in array columns[]. Implement this method in a way, that an array of the same length as the columntitles is produced containing the data at the point of time this method is called by someone else to produce up-to-date information.

Specified by:

getEntries in class Reporter

Returns:

java.lang.String[] : Array containing the data for reporting

getHistColumnTitles

public java.lang.String[] getHistColumnTitles()

Returns an array of Strings each containing the title for the corresponding column of the histogram part (table).

Returns:

java.lang.String[] : Array containing column titles of the histogram part (table).

getHistEntries

public java.lang.String[][] getHistEntries()

Returns a two-dimensional array of Strings containing the data for the histogram part of this HistogramReporter. Implement this method in a way, that the data is collected at the point of time this method is called by someone else to produce up-to-date information.

Returns:

java.lang.String[][] : Array containing the data for reporting about the histogram part of this HistogramReporter.

getHistNumColumns

public int getHistNumColumns()

Returns the number of columns of the histogram part (table) of this HistogramReporter.

Returns:

int : The number of columns of the histogram part (table) of this HistogramReporter

getNoOfCells

public int getNoOfCells()

Returns the number of cells the interval of the given Histogram is devided into.

Returns:

int : The number of cells the interval of the given Histogram is devided into.

getObservations

public long getObservations()

Returns the number of observations made by the Histogram object. This method call is passed on to the Histogram object.

Returns:

long : The number of observations made by the Histogram object.

getChartData

public ChartDataHistogramLong getChartData()

Returns the data for the histogram chart.

Returns:

isContinuingReporter

public boolean isContinuingReporter()

Overrides:

isContinuingReporter in class Reporter