desmoj.core.statistic

Class ValueStatistics

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

All Implemented Interfaces:

java.util.Observer

Direct Known Subclasses:

Accumulate, Tally

public abstract class ValueStatistics
extends StatisticObjectSupportingTimeSpans

The ValueStatistics class is the super class for all the classes providing a statistic analysis about one value (e.g. minimum and maximum values). Derived classes are: Tally, Accumulate and Histogram (because it is derived from Tally).

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.

Field Summary

Fields inherited from class desmoj.core.statistic.StatisticObject

UNDEFINED

Constructor Summary

Constructors

Constructor and Description
ValueStatistics(Model ownerModel, java.lang.String name, boolean showInReport, boolean showInTrace) Constructor for a ValueStatistics object that has NO connection to a ValueSupplier.
ValueStatistics(Model ownerModel, java.lang.String name, ValueSupplier valSup, boolean showInReport, boolean showInTrace) Constructor for a ValueStatistics object that will be connected to a ValueSupplier.

Method Summary

Modifier and Type	Method and Description
double	getLastValue() Returns the last observed value of this ValueStatistics object.
double	getMaximum() Returns the maximum value observed so far.
abstract double	getMean() Returns the mean value of all the values observed so far.
double	getMinimum() Returns the minimum value observed so far.
abstract double	getStdDev() Returns the standard deviation of all the values observed so far.
void	reset() Resets this ValueStatistics object by resetting all variables to 0.0 .
void	update() Updates this ValueStatistics object by fetching the actual value of the ValueSupplier and processing it.
void	update(double val) Updates this ValueStatistics 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.
void	update(TimeSpan t) Updates this data collector object with a specific TimeSpan.

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

ValueStatistics

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

Constructor for a ValueStatistics object that will be connected to a ValueSupplier.

Parameters:

ownerModel - Model : The model this ValueStatistics is associated to

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

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

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

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

ValueStatistics

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

Constructor for a ValueStatistics object that has NO connection to a ValueSupplier.

Parameters:

ownerModel - Model : The model this ValueStatistics is associated to

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

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

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

Method Detail

getLastValue

public double getLastValue()

Returns the last observed value of this ValueStatistics object.

Returns:

double : The last value observed so far.

getMaximum

public double getMaximum()

Returns the maximum value observed so far.

Returns:

double : The maximum value observed so far.

getMean

public abstract double getMean()

Returns the mean value of all the values observed so far. Has to be implemented in a derived class.

Returns:

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

getMinimum

public double getMinimum()

Returns the minimum value observed so far.

Returns:

double : The minimum value observed so far.

getStdDev

public abstract double getStdDev()

Returns the standard deviation of all the values observed so far. Has to be implemented in a derived class.

Returns:

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

reset

public void reset()

Resets this ValueStatistics object by resetting all variables to 0.0 .

Overrides:

reset in class Reportable

update

public void update(TimeSpan t)

Description copied from class: StatisticObjectSupportingTimeSpans

Updates this data collector object with a specific TimeSpan.

Specified by:

update in class StatisticObjectSupportingTimeSpans

Parameters:

t - TimeSpan : The time span to update this data collector.

update

public void update()

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

update

public void update(double val)

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

Parameters:

val - double : The value with which this ValueStatistics 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.

Parameters:

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

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