desmoj.core.statistic

Class Accumulate

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

All Implemented Interfaces:

java.util.Observer

Direct Known Subclasses:

AccumulateAnimation, HistogramAccumulate

public class Accumulate
extends ValueStatistics

The Accumulate class is providing a statistic analysis about one value. The mean value and the standard deviation is weighted over time.

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
Accumulate(Model ownerModel, java.lang.String name, boolean showInReport, boolean showInTrace) Constructor for a Accumulate object that will not be connected to a ValueSupplier automatically.
Accumulate(Model ownerModel, java.lang.String name, double initialValue, boolean showInReport, boolean showInTrace) Constructor for a Accumulate object that will not be connected to a ValueSupplier automatically.
Accumulate(Model ownerModel, java.lang.String name, ValueSupplier valSup, boolean automatic, boolean showInReport, boolean showInTrace) Constructor for a Accumulate object that will be connected to a ValueSupplier, from which the values will be fetched.

Method Summary

Modifier and Type	Method and Description
Reporter	createDefaultReporter() Returns a Reporter to produce a report about this Accumulate.
boolean	doesRetainLastValueOnReset() This method determines whether if the accumulate's last value is retained on reset (true) or nullified (false).
double	getMean() Returns the mean value of all the values observed so far, weighted over time.
TimeSpan	getPeriodMeasured() Returns the period measured (excluding pauses).
double	getStdDev() Returns the standard deviation of all the values observed so far, weighted over time.
void	pause() Temporarily suspend data collection to exclude a period, e.g. to disregard the night period in which a plant is closed from machine utilization statistics.
void	reset() Resets this Accumulate object by resetting all variables to 0.0.
void	setRetainLastValueOnReset(boolean retainValue) Sets the value of the retainLastValueOnResetFlag.
void	update() Updates this Accumulate object by fetching the actual value of the ValueSupplier and processing it.
void	update(double val) Updates this Accumulate 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

Accumulate

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

Constructor for a Accumulate object that will be connected to a ValueSupplier, from which the values will be fetched.

Parameters:

ownerModel - Model : The model this Accumulate is associated to

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

valSup - ValueSupplier : The ValueSupplier providing the value for this Accumulate. The given ValueSupplier will be observed by this Accumulate object, if it is not observed automatically at every tick of the SimClock.

automatic - boolean : Flag for observing the ValueSupplier at every tick of the SimClock. Set it to true to have it observed at every SimClock tick.

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

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

Accumulate

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

Constructor for a Accumulate object that will not be connected to a ValueSupplier automatically. No specific initial value is assumed, so that the period covered effectively begins after the first update.

Parameters:

ownerModel - Model : The model this Accumulate is associated to

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

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

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

Accumulate

public Accumulate(Model ownerModel,
                  java.lang.String name,
                  double initialValue,
                  boolean showInReport,
                  boolean showInTrace)

Constructor for a Accumulate object that will not be connected to a ValueSupplier automatically. An initial value stated explicitly will be assumed after creation/reset.

Parameters:

ownerModel - Model : The model this Accumulate is associated to

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

initialValue - double : Value to assume initially and after resets.

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

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

Method Detail

createDefaultReporter

public Reporter createDefaultReporter()

Returns a Reporter to produce a report about this Accumulate.

Returns:

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

getPeriodMeasured

public TimeSpan getPeriodMeasured()

Returns the period measured (excluding pauses).

Returns:

TimeSpan : The period measured (excluding pauses).

getMean

public double getMean()

Returns the mean value of all the values observed so far, weighted over time.

Specified by:

getMean in class ValueStatistics

Returns:

double : The mean value of all the values observed so far, weighted over time.

getStdDev

public double getStdDev()

Returns the standard deviation of all the values observed so far, weighted over time.

Specified by:

getStdDev in class ValueStatistics

Returns:

double : The standard deviation of all the values observed so far, weighted over time.

reset

public void reset()

Resets this Accumulate object by resetting all variables to 0.0. If the flag retainLastValueOnReset is set to true, the last value is not nullified but remains unchanged.

Overrides:

reset in class ValueStatistics

doesRetainLastValueOnReset

public boolean doesRetainLastValueOnReset()

This method determines whether if the accumulate's last value is retained on reset (true) or nullified (false). The default value is true.

Returns:

value of the retainLastValueOnReset flag

setRetainLastValueOnReset

public void setRetainLastValueOnReset(boolean retainValue)

Sets the value of the retainLastValueOnResetFlag.

Parameters:

retainValue - new value of the flag.

update

public void update()

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

pause

public void pause()

Temporarily suspend data collection to exclude a period, e.g. to disregard the night period in which a plant is closed from machine utilization statistics. Data collection will be resumed automatically on calling an update(...)-method.