Class MaxTraceFunction

java.lang.Object
microsim.statistics.functions.AbstractFunction
microsim.statistics.functions.MaxTraceFunction
All Implemented Interfaces:
EventListener, IDoubleSource, IUpdatableSource
Direct Known Subclasses:
MaxTraceFunction.Double, MaxTraceFunction.Float, MaxTraceFunction.Integer, MaxTraceFunction.Long
@Deprecated(forRemoval=true) public abstract class MaxTraceFunction extends AbstractFunction implements IDoubleSource
Deprecated, for removal: This API element is subject to removal in a future version.
use AccumulatorStats
A MixFunction object is to collect data over time, computing some statistics on the fly, without storing the data in memory. It is particularly useful when the user need to compute basic statistics on data sources, without affecting the memory occupancy. The memoryless series computes automatically the statistics using accumulation variables and counters.
This statistic computer should be used when possible, particularly when the simulation model has to run for a long time, condition which implies the growth of the memory occupancy. Moreover the MemorylessSeries objects are much faster than the Series one, because they pre-compute the statistics operation step by step. Trying to compute a mean of a Series object, force the Mean function to sum all the values, every time series is updated.

Title: JAS

Description: Java Agent-based Simulation library

Copyright (C) 2002 Michele Sonnessa

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
Author:
Michele Sonnessa and Ross Richardson

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    MaxTraceFunction.Double
    Deprecated, for removal: This API element is subject to removal in a future version.
    An implementation of the MemorylessSeries class, which manages double type data sources.
    static class 
    MaxTraceFunction.Float
    Deprecated, for removal: This API element is subject to removal in a future version.
    An implementation of the MemorylessSeries class, which manages float type data sources.
    static class 
    MaxTraceFunction.Integer
    Deprecated, for removal: This API element is subject to removal in a future version.
    An implementation of the MemorylessSeries class, which manages integer type data sources.
    static class 
    MaxTraceFunction.Long
    Deprecated, for removal: This API element is subject to removal in a future version.
    An implementation of the MemorylessSeries class, which manages long type data sources.
    static enum 
    MaxTraceFunction.Variables
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected int
    count
    Deprecated, for removal: This API element is subject to removal in a future version.
     

    Fields inherited from class AbstractFunction

    timeChecker

  • Constructor Summary

    Constructors
    Constructor
    Description
    MaxTraceFunction()
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    applyFunction()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Collect a value from the source.
    void
    onEvent(Enum<?> type)
    Deprecated, for removal: This API element is subject to removal in a future version.
    ISimEventListener callback function.

    Methods inherited from class AbstractFunction

    isCheckingTime, setCheckingTime, updateSource

    Methods inherited from class Object

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

    Methods inherited from interface IDoubleSource

    getDoubleValue

  • Field Details

    • count

      protected int count
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Constructor Details

    • MaxTraceFunction

      public MaxTraceFunction()
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • applyFunction

      public void applyFunction()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Collect a value from the source.
      Specified by:
      applyFunction in class AbstractFunction

    • onEvent

      public void onEvent(Enum<?> type)
      Deprecated, for removal: This API element is subject to removal in a future version.
      ISimEventListener callback function. It supports only jas.engine.Sim.EVENT_UPDATE event.
      Specified by:
      onEvent in interface EventListener
      Overrides:
      onEvent in class AbstractFunction
      Throws:
      UnsupportedOperationException - If actionType is not supported.