Package nl.tudelft.simulation.dsol.statistics

Class SimCounter<T extends Number & Comparable<T>>

java.lang.Object

org.djutils.stats.summarizers.Counter

org.djutils.stats.summarizers.event.EventBasedCounter

nl.tudelft.simulation.dsol.statistics.SimCounter<T>

Type Parameters:

T - the absolute simulation time to use in the warmup event

All Implemented Interfaces:

Serializable, Remote, EventListener, SimulationStatistic<T>, EventListener, EventProducer, Statistic

public class SimCounter<T extends Number & Comparable<T>>
extends EventBasedCounter
implements SimulationStatistic<T>

The time-aware counter extends the djutils event-based counter and links it to the dsol framework.

Copyright (c) 2002-2023 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See for project information https://simulation.tudelft.nl. The DSOL project is distributed under a three-clause BSD-style license, which can be found at https://https://simulation.tudelft.nl/dsol/docs/latest/license.html.

Author:

Peter Jacobs

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static EventType	TIMED_INITIALIZED_EVENT	INITIALIZED_EVENT is fired whenever a Tally is (re-)initialized.
static EventType	TIMED_OBSERVATION_ADDED_EVENT	OBSERVATION_ADDED_EVENT is fired whenever an observation is processed.

Fields inherited from interface org.djutils.event.EventProducer

FIRST_POSITION, LAST_POSITION

Constructor Summary

Constructors

Constructor	Description
SimCounter(String description, DsolModel<T,? extends SimulatorInterface<T>> model)	Construct a new SimCounter, and register the counter in the OutputStatistics of the model.
SimCounter(String description, DsolModel<T,? extends SimulatorInterface<T>> model, EventProducer target, EventType eventType)	constructs a new SimCounter.

Method Summary

Modifier and Type	Method	Description
SimulatorInterface<T>	getSimulator()	Return the simulator.
void	initialize()
void	notify(Event event)
long	register(long value)

Methods inherited from class org.djutils.stats.summarizers.event.EventBasedCounter

fireEvents, getEventListenerMap

Methods inherited from class org.djutils.stats.summarizers.Counter

getCount, getDescription, getN, reportFooter, reportHeader, reportLine, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.djutils.event.EventProducer

addListener, addListener, addListener, addListener, fireEvent, fireEvent, fireEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireUnverifiedEvent, fireUnverifiedEvent, fireUnverifiedTimedEvent, fireUnverifiedTimedEvent, getEventTypesWithListeners, getListenerReferences, hasListeners, numberOfListeners, removeAllListeners, removeAllListeners, removeListener

Methods inherited from interface nl.tudelft.simulation.dsol.statistics.SimulationStatistic

getDescription, getN

Methods inherited from interface org.djutils.stats.summarizers.Statistic

formatFixed

Field Detail

TIMED_OBSERVATION_ADDED_EVENT

public static final EventType TIMED_OBSERVATION_ADDED_EVENT

OBSERVATION_ADDED_EVENT is fired whenever an observation is processed.

TIMED_INITIALIZED_EVENT

public static final EventType TIMED_INITIALIZED_EVENT

INITIALIZED_EVENT is fired whenever a Tally is (re-)initialized.

Constructor Detail

SimCounter

public SimCounter(String description,
                  DsolModel<T,? extends SimulatorInterface<T>> model)

Construct a new SimCounter, and register the counter in the OutputStatistics of the model.

Parameters:

description - String; refers to the description of this counter

model - DsolModel<T, SimulatorInterface<T>>; the model

SimCounter

public SimCounter(String description,
                  DsolModel<T,? extends SimulatorInterface<T>> model,
                  EventProducer target,
                  EventType eventType)

constructs a new SimCounter.

Parameters:

description - String; the description

model - DsolModel<T, SimulatorInterface<T>>; the model

target - EventProducer; the target on which to count

eventType - EventType; the EventType for which counting takes place

Method Detail

initialize

public void initialize()

Specified by:

initialize in interface Statistic

Overrides:

initialize in class EventBasedCounter

register

public long register(long value)

Overrides:

register in class EventBasedCounter

notify

public void notify(Event event)

Specified by:

notify in interface EventListener

Overrides:

notify in class EventBasedCounter

getSimulator

public SimulatorInterface<T> getSimulator()

Return the simulator.

Specified by:

getSimulator in interface SimulationStatistic<T extends Number & Comparable<T>>

Returns:

SimulatorInterface; the simulator for this dsol statistic