Class AbstractFunction

java.lang.Object
microsim.statistics.functions.AbstractFunction
All Implemented Interfaces:
EventListener, IUpdatableSource
Direct Known Subclasses:
AbstractArrayFunction, AbstractWeightedArrayFunction, MaxTraceFunction, MinTraceFunction, MovingAverageTraceFunction
@Deprecated(forRemoval=true) public abstract class AbstractFunction extends Object implements EventListener, IUpdatableSource
Deprecated, for removal: This API element is subject to removal in a future version.
unnecessary with Stats
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

  • Field Summary

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

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract void
    applyFunction()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    isCheckingTime()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Return the current status of the time checker.
    void
    onEvent(Enum<?> type)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Update the source, invoking the updateSource() method.
    void
    setCheckingTime(boolean b)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Set the current status of the time checker.
    void
    updateSource()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Force the source to update its currently cached data.

    Methods inherited from class Object

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

  • Field Details

    • timeChecker

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

  • Constructor Details

    • AbstractFunction

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

  • Method Details

    • onEvent

      public void onEvent(Enum<?> type)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Update the source, invoking the updateSource() method.
      Specified by:
      onEvent in interface EventListener
      Throws:
      UnsupportedOperationException - if actionId is not equal to the jas.engine.Sim.EVENT_UPDATE value.

    • isCheckingTime

      public boolean isCheckingTime()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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.

    • updateSource

      public void updateSource()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: IUpdatableSource
      Force the source to update its currently cached data.
      Specified by:
      updateSource in interface IUpdatableSource

    • applyFunction

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