Package org.djutils.stats.summarizers.event

Class EventBasedWeightedTally

java.lang.Object

org.djutils.stats.summarizers.WeightedTally

org.djutils.stats.summarizers.event.EventBasedWeightedTally

All Implemented Interfaces:

Serializable, Remote, EventListener, EventListener, EventProducer, Statistic, TallyStatistic

public class EventBasedWeightedTally
extends WeightedTally
implements EventProducer, EventListener

The EventBasedWeightedTally class defines a time-weighted tally that can be notified with weights and values using the EventListener. It also produces events when values are tallied and when the tally is initialized. It embeds an EventProducer so it can keep listeners informed about new observations.

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://simulation.tudelft.nl/dsol/3.0/license.html.

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Field Summary

Fields inherited from class org.djutils.stats.summarizers.WeightedTally

semaphore

Fields inherited from interface org.djutils.event.EventProducer

FIRST_POSITION, LAST_POSITION

Constructor Summary

Constructors

Constructor	Description
EventBasedWeightedTally(String description)	Construct a new WeightedTally with a description.
EventBasedWeightedTally(String description, EventProducer eventProducer)	Construct a new WeightedTally with a description.

Method Summary

Modifier and Type	Method	Description
protected void	fireEvents()	Method that can be overridden to fire own events or additional events when registering an observation.
EventListenerMap	getEventListenerMap()
void	initialize()	Initialize the statistic.
void	notify(Event event)
double	register(double weight, double value)	Process one observed weighted value.
String	toString()

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

getDescription, getMax, getMin, getN, getWeightedPopulationMean, getWeightedPopulationStDev, getWeightedPopulationVariance, getWeightedSampleMean, getWeightedSampleStDev, getWeightedSampleVariance, getWeightedSum, reportFooter, reportHeader, reportLine

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 org.djutils.stats.summarizers.Statistic

formatFixed

Constructor Detail

EventBasedWeightedTally

public EventBasedWeightedTally(String description)

Construct a new WeightedTally with a description.

Parameters:

description - String; the description of this WeightedTally

EventBasedWeightedTally

public EventBasedWeightedTally(String description,
                               EventProducer eventProducer)

Construct a new WeightedTally with a description.

Parameters:

description - String; the description of this WeightedTally

eventProducer - EventProducer; the EventProducer to embed and use in this statistic

Method Detail

getEventListenerMap

public EventListenerMap getEventListenerMap()
                                     throws RemoteException

Specified by:

getEventListenerMap in interface EventProducer

Throws:

RemoteException

initialize

public void initialize()

Initialize the statistic.

Specified by:

initialize in interface Statistic

Overrides:

initialize in class WeightedTally

notify

public void notify(Event event)

Specified by:

notify in interface EventListener

register

public double register(double weight,
                       double value)

Process one observed weighted value.

Overrides:

register in class WeightedTally

Parameters:

weight - double; the weight of the value to process

value - double; the value to process

Returns:

double; the value

fireEvents

protected void fireEvents()
                   throws RemoteException

Method that can be overridden to fire own events or additional events when registering an observation.

Throws:

RemoteException - on network error

toString

public String toString()

Overrides:

toString in class WeightedTally