desmoj.core.statistic

Class TallyRunning

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

All Implemented Interfaces:

java.util.Observer

public class TallyRunning
extends Tally

The TallyRunning class is extended from Tally. Same as Tally, it provides statistic analysis about one value (mean, standard deviation, minimum, maximum). In addition, this class is able to calculate this data based on the last n samples only, subject to n passed to the constructor.

Version:

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

Author:

Soenke Claassen, Johannes Göbel, 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:

Tally

Field Summary

Fields inherited from class desmoj.core.statistic.StatisticObject

UNDEFINED

Constructor Summary

Constructors

Constructor and Description
TallyRunning(Model ownerModel, java.lang.String name, int n, boolean showInReport, boolean showInTrace) Constructor for a Tally object that has no connection to a ValueSupplier.
TallyRunning(Model ownerModel, java.lang.String name, ValueSupplier valSup, int n, boolean showInReport, boolean showInTrace) Constructor for a TallyRunning 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	getMaximumLastN() Returns the maximum of the last n values.
double	getMeanLastN() Returns the mean value of the last n values observed.
double	getMinimumLastN() Returns the minimum of the last n values.
int	getSampleSizeN() Returns the sample size n.
double	getStdDevLastN() Returns the standard deviation of the last n values observed.
void	reset() Resets this TallyRunning object by resetting all variables to 0.0 .
void	update() Updates this TallyRunning object by fetching the actual value of the ValueSupplier and processing it.
void	update(double val) Updates this TallyRunning 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

TallyRunning

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

Constructor for a TallyRunning 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.

n - int : Number of samples to include in running statistic data.

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

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

TallyRunning

public TallyRunning(Model ownerModel,
                    java.lang.String name,
                    int n,
                    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

n - int : Number of samples to include in running statistic data.

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.

Overrides:

createDefaultReporter in class Tally

Returns:

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

getMeanLastN

public double getMeanLastN()

Returns the mean value of the last n values observed. Note that if less than n samples values are observed this far, the value returned will only include fewer (i.e. all) samples.

Returns:

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

getStdDevLastN

public double getStdDevLastN()

Returns the standard deviation of the last n values observed. Note that if less than n samples values are observed this far, the value returned will only include fewer (i.e. all) samples.

Returns:

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

reset

public void reset()

Resets this TallyRunning object by resetting all variables to 0.0 .

Overrides:

reset in class Tally

update

public void update()

Updates this TallyRunning object by fetching the actual value of the ValueSupplier and processing it. The ValueSupplier is passed in the constructor of this TallyRunning 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 TallyRunning object with the double value given as parameter. In some cases it might be more convenient to pass the value this TallyRunning 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 TallyRunning 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 TallyRunning is updated. Normally a double number which is added to the statistics or null.

getMaximumLastN

public double getMaximumLastN()

Returns the maximum of the last n values.

Returns:

double : The maximum value of the last n values.

getMinimumLastN

public double getMinimumLastN()

Returns the minimum of the last n values.

Returns:

double : The minimum value of the last n values.

getSampleSizeN

public int getSampleSizeN()

Returns the sample size n.

Returns:

int : The sample size n.