desmoj.core.statistic

Class Aggregate

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

All Implemented Interfaces:

java.util.Observer

Direct Known Subclasses:

AggregateAnimation

public class Aggregate
extends StatisticObjectSupportingTimeSpans

The Aggregate class is simply counting (aggregating) a continuous (i.e. double) value during an experiment. Be careful the aggregate can be updated with positive and negative values! To get this Aggregate object updated automatically every time a ValueSupplier has changed, call the addObserver (Observer)-method from the ValueSupplier of interest, where Observer is this Aggregate object.
This must be done by the user in his model!
Consider usage of class Count to aggregate integer values.

Version:

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

Author:

Soenke Claassen, based on DESMO-C from Thomas Schniewind, 1998, modified by Ruth Meyer, Johannes Göbel 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
Aggregate(Model ownerModel, java.lang.String name, boolean showInReport, boolean showInTrace) Constructor for a Aggregate object.
Aggregate(Model ownerModel, java.lang.String name, boolean showInReport, boolean showInTrace, boolean isResetResistant) Constructor for a Aggregate object.

Method Summary

Modifier and Type	Method and Description
Reporter	createDefaultReporter() Returns a Reporter to produce a report about this Aggregate.
double	getMaximum() Returns the maximum value observed so far.
double	getMinimum() Returns the minimum value observed so far.
double	getValue() Returns the current value of the aggregate.
void	reset() Resets this Aggregate object by resetting (nearly) all variables to zero.
void	update(double n) Increments the value of this Aggregate object by the value given in the parameter n.
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

Aggregate

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

Constructor for a Aggregate object.

Parameters:

ownerModel - Model : The model this Aggregate is associated to

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

showInReport - boolean : Flag for showing the report Set it to true if this Aggregate should show up in report. Set it to false if this Aggregate should not be shown in report.

showInTrace - boolean : Flag for showing this Aggregate in trace files. Set it to true if this Aggregate should show up in trace. Set it to false if this Aggregate should not be shown in trace.

Aggregate

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

Constructor for a Aggregate object.

Parameters:

ownerModel - Model : The model this Aggregate is associated to

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

showInReport - boolean : Flag for showing the report Set it to true if this Aggregate should show up in report. Set it to false if this Aggregate should not be shown in report.

showInTrace - boolean : Flag for showing this Aggregate in trace files. Set it to true if this Aggregate should show up in trace. Set it to false if this Aggregate should not be shown in trace.

isResetResistant - boolean : Flag for retaining the value of the aggregate during resets. Set it to true if this Aggregate should retain its current value and only reset min, max and observations to 0. Set it to false if this Aggregate should also reset its value to 0.

Method Detail

createDefaultReporter

public Reporter createDefaultReporter()

Returns a Reporter to produce a report about this Aggregate.

Returns:

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

getMaximum

public double getMaximum()

Returns the maximum value observed so far.

Returns:

double : The maximum value observed so far.

getMinimum

public double getMinimum()

Returns the minimum value observed so far.

Returns:

double : The minimum value observed so far.

reset

public void reset()

Resets this Aggregate object by resetting (nearly) all variables to zero. If the flag isResetResistant is set to true the value of the aggregate will NOT be changed.

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(double n)

Increments the value of this Aggregate object by the value given in the parameter n.

Parameters:

n - double : The number that will be added to the value of this Aggregate object.

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 Aggregate is updated. Normally a double number which is added to the value of the aggregate or null.

getValue

public double getValue()

Returns the current value of the aggregate.

Returns:

double : the current value of the aggregate.