desmoj.core.report

Class TextHistogramReporter

java.lang.Object

desmoj.core.report.Reporter

desmoj.core.report.TextHistogramReporter

public class TextHistogramReporter
extends Reporter

Captures all relevant information about the TextHistogram.

Version:

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

Author:

Lorna Slawski based on the class HistogramReporter, Soenke Claassen based on ideas from Tim Lechler, based on DESMO-C from Thomas Schniewind, 1998 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
TextHistogramReporter(Reportable informationSource) Constructor for a new TextHistogramReporter.

Method Summary

Modifier and Type	Method and Description
ChartDataHistogramLong	getChartData() Returns the data for the TextHistogram chart.
java.lang.String[]	getEntries() Returns an array of Strings each containing the data for the corresponding column in array
int	getNoOfStrings() Returns the number of Strings the given TextHistogram has saved.
long	getObservations() Returns the number of observations made by the TextHistogram object.
java.lang.String[]	getTextHistColumnTitles() Returns an array of Strings each containing the title for the corresponding column of the histogram part (table).
java.lang.String[][]	getTextHistEntries() Returns a two-dimensional array of Strings containing the data for the histogram part of this TextHistogramReporter.
int	getTextHistNumColumns() Returns the number of columns of the histogram part (table) of this TextHistogramReporter.
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

TextHistogramReporter

public TextHistogramReporter(Reportable informationSource)

Constructor for a new TextHistogramReporter. Note that although any Reportable is accepted you should make sure that only subtypes of TextHistogram 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 TextHistogram 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

Specified by:

getEntries in class Reporter

Returns:

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

getTextHistColumnTitles

public java.lang.String[] getTextHistColumnTitles()

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).

getTextHistEntries

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

Returns a two-dimensional array of Strings containing the data for the histogram part of this TextHistogramReporter. 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 TextHistogramReporter.

getTextHistNumColumns

public int getTextHistNumColumns()

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

Returns:

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

getNoOfStrings

public int getNoOfStrings()

Returns the number of Strings the given TextHistogram has saved.

Returns:

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

getObservations

public long getObservations()

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

Returns:

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

getChartData

public ChartDataHistogramLong getChartData()

Returns the data for the TextHistogram chart.

Returns:

isContinuingReporter

public boolean isContinuingReporter()

Overrides:

isContinuingReporter in class Reporter