jas.statistics.functions
Class AbstractFunction

java.lang.Object
  jas.statistics.functions.AbstractFunction

All Implemented Interfaces:

ISimEventListener, IUpdatableSource

Direct Known Subclasses:

AbstractArrayFunction, MaxTraceFunction, MinTraceFunction, MovingAverageTraceFunction

public abstract class AbstractFunction
extends java.lang.Object
implements ISimEventListener, 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

Constructor Summary

AbstractFunction()

Method Summary

abstract void	applyFunction()
boolean	isCheckingTime() Return the current status of the time checker.
void	performAction(int actionId) 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

applyFunction

public abstract void applyFunction()

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.

performAction

public void performAction(int actionId)

Update the source, invoking the updateSource() method.

Specified by:

performAction in interface ISimEventListener

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.

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.

updateSource

public void updateSource()

Description copied from interface: IUpdatableSource

Force the source to update its currently cached data.

Specified by:

updateSource in interface IUpdatableSource