desmoj.core.statistic

Class StatisticObjectSupportingTimeSpans

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Reportable

desmoj.core.statistic.StatisticObject

desmoj.core.statistic.StatisticObjectSupportingTimeSpans

All Implemented Interfaces:

java.util.Observer

Direct Known Subclasses:

Aggregate, TimeSeries, ValueStatistics

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

StatisticObjectSupportingTimeSpans class is the super class of the specific data collector classes able to handle TimeSpan objects. If the data collector should be used to measure the lengths of TimeSpans, the method setShowTimeSpansInReport(true) should be called to appropriately assign the (reference) unit.

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
StatisticObjectSupportingTimeSpans(Model ownerModel, java.lang.String name, boolean showInReport, boolean showInTrace) Constructor for a StatisticObjectSupportingTimeSpans, preliminarily without a unit assigned

Method Summary

Modifier and Type	Method and Description
boolean	getShowTimeSpansInReport() Are values printed as TimeSpans in the report?
java.lang.String	getUnit() Get an optional unit of reported value.
void	setShowTimeSpansInReport(boolean value) Sets if values should be interpreted and printed as TimeSpans (subject to the experiment's reference unit) in the Report.
abstract void	update(TimeSpan t) Updates this data collector object with a specific TimeSpan.

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, 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

Constructor Detail

StatisticObjectSupportingTimeSpans

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

Constructor for a StatisticObjectSupportingTimeSpans, 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

update

public abstract void update(TimeSpan t)

Updates this data collector object with a specific TimeSpan.

Parameters:

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

getUnit

public java.lang.String getUnit()

Description copied from class: StatisticObject

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

Overrides:

getUnit in class StatisticObject

Returns:

String : The optional unit

setShowTimeSpansInReport

public void setShowTimeSpansInReport(boolean value)

Sets if values should be interpreted and printed as TimeSpans (subject to the experiment's reference unit) in the Report. Unless a unit is explicitly otherwise using setUnit(...), this class assumes updates refer to the reference time unit.

Parameters:

value - boolean : true, if values should be printed as TimeSpans, false if not.

getShowTimeSpansInReport

public boolean getShowTimeSpansInReport()

Are values printed as TimeSpans in the report?

Returns:

true if values are printed as TimeSpans, false if not.