desmoj.core.statistic

Class Count

java.lang.Object

desmoj.core.simulator.NamedObject

desmoj.core.simulator.ModelComponent

desmoj.core.simulator.Reportable

desmoj.core.statistic.StatisticObject

desmoj.core.statistic.Count

All Implemented Interfaces:

java.util.Observer

Direct Known Subclasses:

CountAnimation

public class Count
extends StatisticObject

The Count class is simply counting something during an experiment. Be careful the counter can be updated with positive and negative integer numbers! To get this Count object updated automatically every time a ValueSupplier has changed, call the addObserver (Observer) -method from the ValueSupplier of interest, where Observer is this Count object.
This must be done by the user in his model!
Consider usage of class Aggregate to count non-integer (i.e. double) 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 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
Count(Model ownerModel, java.lang.String name, boolean showInReport, boolean showInTrace) Constructor for a Count object.
Count(Model ownerModel, java.lang.String name, boolean showInReport, boolean showInTrace, boolean isResetResistant) Constructor for a Count object.

Method Summary

Modifier and Type	Method and Description
void	activateInterArrivalTimeTally() Activates the inter-arrival-time Tally to observe the timespans between calls of the update-Method.
void	activateInterArrivalTimeTally(boolean showTimeSpansInReport) Activates the inter-arrival-time Tally to observe the timespans between calls of the update-Method.
void	activateInterArrivalTimeTally(java.lang.Class<? extends Reporter> reporterClass, boolean showTimeSpansInReport) Activates the inter-arrival-time Tally to observe the timespans between calls of the update-Method.
Reporter	createDefaultReporter() Returns a Reporter to produce a report about this Count.
void	deactivateInterArrivalTimeTally() Deactivates the inter-arrival-time Tally to stop observing the timespans between calls of the update-Method.
long	getMaximum() Returns the maximum value observed so far.
long	getMinimum() Returns the minimum value observed so far.
long	getValue() Returns the current counter value.
boolean	isInterArrivalTimeTallyActivated() Is the time between calls of the update-method be observed by a Tally?
void	reset() Resets this Count object by resetting (nearly) all variables to zero.
void	setCorrespondingSchedulable(Schedulable correspondingSchedulable) Sets the schedulable (e.g. entity) corresponding to this Reportable.
void	update() Increments the counter of this Count object by one.
void	update(long n) Increments the counter of this Count 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.

Methods inherited from class desmoj.core.statistic.StatisticObject

getUnit, getUnitText, round, setUnit

Methods inherited from class desmoj.core.simulator.Reportable

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

Count

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

Constructor for a Count object.

Parameters:

ownerModel - Model : The model this Count is associated to

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

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

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

Count

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

Constructor for a Count object.

Parameters:

ownerModel - Model : The model this Count is associated to

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

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

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

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

Method Detail

createDefaultReporter

public Reporter createDefaultReporter()

Returns a Reporter to produce a report about this Count.

Returns:

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

setCorrespondingSchedulable

public void setCorrespondingSchedulable(Schedulable correspondingSchedulable)

Sets the schedulable (e.g. entity) corresponding to this Reportable. May be null if no schedulable corresponds to this reportable. If set, the schedulable must have the same model as this reportable! A Reportable needs not have a corresponding schedulable.

Overrides:

setCorrespondingSchedulable in class Reportable

Parameters:

correspondingSchedulable - Schedulable : The Schedulable corresponding to this Reportable.

getMaximum

public long getMaximum()

Returns the maximum value observed so far.

Returns:

long : The maximum value observed so far.

getMinimum

public long getMinimum()

Returns the minimum value observed so far.

Returns:

long : The minimum value observed so far.

reset

public void reset()

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

Overrides:

reset in class Reportable

update

public void update()

Increments the counter of this Count object by one.

update

public void update(long n)

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

Parameters:

n - long : The number that will be added to the counter of this Count 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 Count is updated. Normally a long number which is added to the counter or null.

getValue

public long getValue()

Returns the current counter value.

Returns:

long : the current counter value.

isInterArrivalTimeTallyActivated

public boolean isInterArrivalTimeTallyActivated()

Is the time between calls of the update-method be observed by a Tally?

Returns:

true if the inter-arrival-time will be observed, false if not.

activateInterArrivalTimeTally

public void activateInterArrivalTimeTally(java.lang.Class<? extends Reporter> reporterClass,
                                          boolean showTimeSpansInReport)

Activates the inter-arrival-time Tally to observe the timespans between calls of the update-Method.

Parameters:

reporterClass - Class : A reporter to be used by the Tally.

showTimeSpansInReport - boolean : Should the Reporter for the Tally use TimeSpans in Report?

activateInterArrivalTimeTally

public void activateInterArrivalTimeTally(boolean showTimeSpansInReport)

Activates the inter-arrival-time Tally to observe the timespans between calls of the update-Method.

Parameters:

showTimeSpansInReport - boolean : Should the Reporter for the Tally use TimeSpans in Report?

activateInterArrivalTimeTally

public void activateInterArrivalTimeTally()

Activates the inter-arrival-time Tally to observe the timespans between calls of the update-Method.

deactivateInterArrivalTimeTally

public void deactivateInterArrivalTimeTally()

Deactivates the inter-arrival-time Tally to stop observing the timespans between calls of the update-Method.