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, org.djutils.event.EventListener, org.djutils.event.EventProducer, Statistic, TallyStatistic
public class EventBasedWeightedTally extends WeightedTally implements org.djutils.event.EventProducer, org.djutils.event.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-2024 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:

  • Constructor Details

    • 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, org.djutils.event.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 Details

    • getEventListenerMap

      public org.djutils.event.EventListenerMap getEventListenerMap() throws RemoteException
      Specified by:
      getEventListenerMap in interface org.djutils.event.EventProducer
      Throws:
      RemoteException

    • initialize

      public void initialize()
      Description copied from interface: Statistic
      Initialize the statistic.
      Specified by:
      initialize in interface Statistic
      Overrides:
      initialize in class WeightedTally

    • notify

      public void notify(org.djutils.event.Event event)
      Specified by:
      notify in interface org.djutils.event.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