desmoj.core.statistic

Class StatisticObject

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Reportable

desmoj.core.statistic.StatisticObject

All Implemented Interfaces:

java.util.Observer

Direct Known Subclasses:

Count, Regression, StatisticObjectSupportingTimeSpans

public abstract class StatisticObject
extends Reportable
implements java.util.Observer

StatisticObject class is the super class of all other classes collecting statistical data.
It extends the desmoj.core.simulator.Reportable class so that it can provide a reporter to represent the statistical data in the report.
It also implements the java.util.Observer interface. So this is the observer part of the observer pattern as described in [Gamm95] that is observing the desmoj.statistic.ValueSupplier. Whenever the ValueSupplier is changing it calls the update(Observable, Object) method of this StatisticObject. Which happens inside the notifyObservers() method of the observable ValueSupplier.

The virtual method update(Observable, Object) has to be implemented in all derived classes so that the StatisticObject is updated when the observed ValueSupplier has changed and its notifyObservers() method is called from its notifyStatistics() method.

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:

ValueSupplier

Field Summary

Fields

Modifier and Type	Field and Description
static double	UNDEFINED Represents the value returned in case of an error.

Constructor Summary

Constructors

Constructor and Description
StatisticObject(Model ownerModel, java.lang.String name, boolean showInReport, boolean showInTrace) Constructor for a StatisticObject, preliminarily without a unit assigned

Method Summary

Modifier and Type	Method and Description
java.lang.String	getUnit() Get an optional unit of reported value.
java.lang.String	getUnitText() Textually wraps the output of getUnit(), adding brackets and displaying "none" if case unit is null.
static double	round(double d) Rounds a double value with repect to the PRECISION.
void	setUnit(java.lang.String unit) Set an optional unit of reported value.

Methods inherited from class desmoj.core.simulator.Reportable

getCorrespondingSchedulable, getDescription, getObservations, getReporter, incrementObservations, incrementObservations, reportIsOn, reportOff, reportOn, reset, 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

Methods inherited from interface java.util.Observer

update

Field Detail

UNDEFINED

public static final double UNDEFINED

Represents the value returned in case of an error. If no valid value can be returned.

See Also:

Constant Field Values

Constructor Detail

StatisticObject

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

Constructor for a StatisticObject, preliminarily without a unit assigned

Parameters:

ownerModel - Model : The model this StatisticObject is associated to.

name - java.lang.String : The name of this StatisticObject

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

showInTrace - boolean : Flag for showing this StatisticObject in trace files.

Method Detail

round

public static double round(double d)

Rounds a double value with repect to the PRECISION.

Parameters:

d - double : The value to be rounded

Returns:

double : The rounded value.

setUnit

public void setUnit(java.lang.String unit)

Set an optional unit of reported value. Default is null. This value is shown in description reports.

getUnit

public java.lang.String getUnit()

Get an optional unit of reported value. Default is null. This value is shown in description reports.

Returns:

String : The optional unit

getUnitText

public java.lang.String getUnitText()

Textually wraps the output of getUnit(), adding brackets and displaying "none" if case unit is null.

Returns: