desmoj.core.statistic

Class DataListTally

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Reportable

desmoj.core.statistic.StatisticObject

desmoj.core.statistic.StatisticObjectSupportingTimeSpans

desmoj.core.statistic.ValueStatistics

desmoj.core.statistic.Tally

desmoj.core.statistic.DataListTally

All Implemented Interfaces:

java.util.Observer

public class DataListTally
extends Tally

The DataListTally class is providing a statistic analysis about one value. The mean value and the standard deviation is calculated on basis of the total number of observations. All observed values are stored in a list to be able to calculate quartiles or histograms.

Version:

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

Author:

Tim Janz 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.

See Also:

Tally

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DataListTally.DataList A simple List for storing values passed to a Tally.

Field Summary

Fields inherited from class desmoj.core.statistic.StatisticObject

UNDEFINED

Constructor Summary

Constructors

Constructor and Description
DataListTally(Model ownerModel, java.lang.String name, boolean showInReport, boolean showInTrace) Constructor for a DataListTally object.

Method Summary

Modifier and Type	Method and Description
Reporter	createDefaultReporter() Creates a Reporter for this DataListTally.
DataListTally.DataList	getDataListSorted() Returns the sorted DataList.
boolean	getReportDataListHistogram() Will a histogram-reporter be used to create a report for the DataList?
void	reset() Resets the DataListTally and its DataList.
void	setReportDataListHistogram(boolean value) Should a histogram-reporter be used for the DataList?
void	update() Updates this DataListTally object by fetching the actual value of the ValueSupplier and processing it.
void	update(double val) Updates this DataListTally object with the double value given as parameter.
void	update(java.util.Observable o, java.lang.Object arg) Implementation of the virtual update(Observable, Object) method of the Observer interface.

Methods inherited from class desmoj.core.statistic.Tally

getMean, getStdDev

Methods inherited from class desmoj.core.statistic.ValueStatistics

getLastValue, getMaximum, getMinimum, update

Methods inherited from class desmoj.core.statistic.StatisticObjectSupportingTimeSpans

getShowTimeSpansInReport, getUnit, setShowTimeSpansInReport

Methods inherited from class desmoj.core.statistic.StatisticObject

getUnitText, round, setUnit

Methods inherited from class desmoj.core.simulator.Reportable

getCorrespondingSchedulable, getDescription, getObservations, getReporter, incrementObservations, incrementObservations, reportIsOn, reportOff, reportOn, resetAt, setCorrespondingSchedulable, setDescription, setReporter

Methods inherited from class desmoj.core.simulator.ModelComponent

current, currentEntity, currentEntityAll, currentEvent, currentModel, currentSimProcess, debugIsOn, debugOff, debugOn, getModel, isExperimentCompatible, isModelCompatible, presentTime, sendDebugNote, sendMessage, sendTraceNote, sendWarning, skipTraceNote, skipTraceNote, traceIsOn, traceOff, traceOn

Methods inherited from class desmoj.core.simulator.NamedObject

getName, getQuotedName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DataListTally

public DataListTally(Model ownerModel,
                     java.lang.String name,
                     boolean showInReport,
                     boolean showInTrace)

Constructor for a DataListTally object.

Parameters:

ownerModel - Model : The model this Tally is associated to

name - java.lang.String : The name of this Tally object

showInReport - boolean : Flag for showing the report about this Tally.

showInTrace - boolean : Flag for showing the trace output of this Tally.

Method Detail

setReportDataListHistogram

public void setReportDataListHistogram(boolean value)

Should a histogram-reporter be used for the DataList?

Parameters:

value - boolean : true, if the DataList should be reported using a histogram-reporter, false if not.

getReportDataListHistogram

public boolean getReportDataListHistogram()

Will a histogram-reporter be used to create a report for the DataList?

Returns:

true if the reporting is enabled, false if not.

createDefaultReporter

public Reporter createDefaultReporter()

Creates a Reporter for this DataListTally.

Overrides:

createDefaultReporter in class Tally

Returns:

Reporter : The reporter for this DataListTally.

update

public void update()

Updates this DataListTally object by fetching the actual value of the ValueSupplier and processing it. The ValueSupplier is passed in the constructor of this DataListTally object. This update() method complies with the one described in DESMO, see [Page91].

Overrides:

update in class Tally

update

public void update(double val)

Updates this DataListTally object with the double value given as parameter. In some cases it might be more convenient to pass the value this DataListTally will be updated with directly within the update(double val) method instead of going via the ValueSupplier.

Overrides:

update in class Tally

Parameters:

val - double : The value with which this Tally will be updated.

update

public void update(java.util.Observable o,
                   java.lang.Object arg)

Implementation of the virtual update(Observable, Object) method of the Observer interface. This method will be called automatically from an Observable object within its notifyObservers() method.
If no Object (anull value) is passed as arg, the actual value of the ValueSupplier will be fetched with the value() method of the ValueSupplier. Otherwise it is expected that the actual value is passed in the Object arg.

Specified by:

update in interface java.util.Observer

Overrides:

update in class Tally

Parameters:

o - java.util.Observable : The Observable calling this method within its own notifyObservers() method.

arg - Object : The Object with which this Tally is updated. Normally a double number which is added to the statistics or null.

reset

public void reset()

Resets the DataListTally and its DataList.

Overrides:

reset in class Tally

getDataListSorted

public DataListTally.DataList getDataListSorted()

Returns the sorted DataList.

Returns:

the DataList.