Package microsim.statistics.functions

Class AbstractFunction

  • All Implemented Interfaces:
    EventListener, IUpdatableSource
    Direct Known Subclasses:
    AbstractArrayFunction, AbstractWeightedArrayFunction, MaxTraceFunction, MinTraceFunction, MovingAverageTraceFunction
    public abstract class AbstractFunction
extends java.lang.Object
implements EventListener, IUpdatableSource
    An abstract skeleton for the statistical function able to manage update time checking.

    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

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      abstract void applyFunction()  
      boolean isCheckingTime()
      Return the current status of the time checker.
      void onEvent​(java.lang.Enum<?> type)
      Update the source, invoking the updateSource() method.
      void setCheckingTime​(boolean b)
      Set the current status of the time checker.
      void updateSource()
      Force the source to update its currently cached data.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • AbstractFunction

        public AbstractFunction()

    • Method Detail

      • onEvent

        public void onEvent​(java.lang.Enum<?> type)
        Update the source, invoking the updateSource() method.
        Specified by:
        onEvent in interface EventListener
        Parameters:
        actionId - Accepts only the jas.engine.Sim.EVENT_UPDATE value.
        Throws:
        java.lang.UnsupportedOperationException - if actionId is not equal to the jas.engine.Sim.EVENT_UPDATE value.

      • isCheckingTime

        public boolean isCheckingTime()
        Return the current status of the time checker. A time checker avoid the object to update more than one time per simulation step. The default value is enabled (true).
        Returns:
        True if the computer is currently checking time before update cached data, false if disabled.

      • setCheckingTime

        public void setCheckingTime​(boolean b)
        Set the current status of the time checker. A time checker avoid the object to update more than one time per simulation step. The default value is enabled (true).
        Parameters:
        b - True if the computer is currently checking time before update cached data, false if disabled.

      • applyFunction

        public abstract void applyFunction()