desmoj.core.statistic

Class Tally

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

All Implemented Interfaces:

java.util.Observer

Direct Known Subclasses:

ConfidenceCalculator, DataListTally, Histogram, TallyAnimation, TallyRunning

public class Tally
extends ValueStatistics

The Tally 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.

Version:

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

Author:

Soenke Claassen, 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.

See Also:

TallyRunning

Field Summary

Fields inherited from class desmoj.core.statistic.StatisticObject

UNDEFINED

Constructor Summary

Constructors

Constructor and Description
Tally(Model ownerModel, java.lang.String name, boolean showInReport, boolean showInTrace) Constructor for a Tally object that has no connection to a ValueSupplier.
Tally(Model ownerModel, java.lang.String name, ValueSupplier valSup, boolean showInReport, boolean showInTrace) Constructor for a Tally object that is connected to a ValueSupplier.

Method Summary

Modifier and Type	Method and Description
Reporter	createDefaultReporter() Returns a Reporter to produce a report about this Tally.
double	getMean() Returns the mean value of all the values observed so far.
double	getStdDev() Returns the standard deviation of all the values observed so far.
void	reset() Resets this Tally object by resetting all variables to 0.0 .
void	update() Updates this Tally object by fetching the actual value of the ValueSupplier and processing it.
void	update(double val) Updates this Tally 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.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

Tally

public Tally(Model ownerModel,
             java.lang.String name,
             ValueSupplier valSup,
             boolean showInReport,
             boolean showInTrace)

Constructor for a Tally object that is connected to a ValueSupplier.

Parameters:

ownerModel - Model : The model this Tally is associated to

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

valSup - ValueSupplier : The ValueSupplier providing the value for this Tally. The given ValueSupplier will be observed by this Tally object.

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

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

Tally

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

Constructor for a Tally object that has no connection to a ValueSupplier.

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

createDefaultReporter

public Reporter createDefaultReporter()

Returns a Reporter to produce a report about this Tally.

Returns:

desmoj.report.Reporter : The Reporter for this Tally.

getMean

public double getMean()

Returns the mean value of all the values observed so far.

Specified by:

getMean in class ValueStatistics

Returns:

double : The mean value of all the values observed so far.

getStdDev

public double getStdDev()

Returns the standard deviation of all the values observed so far.

Specified by:

getStdDev in class ValueStatistics

Returns:

double : The standard deviation of all the values observed so far.

reset

public void reset()

Resets this Tally object by resetting all variables to 0.0 .

Overrides:

reset in class ValueStatistics

update

public void update()

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

Overrides:

update in class ValueStatistics

update

public void update(double val)

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

Overrides:

update in class ValueStatistics

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 ValueStatistics

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.