jas.statistics.functions
Class MovingAverageTraceFunction

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

All Implemented Interfaces:

ISimEventListener, IDoubleSource, IUpdatableSource

public class MovingAverageTraceFunction
extends AbstractFunction
implements IDoubleSource

This class computes the average of the last values collected from a data source. The number of values used to compute the average value is specified in the constructor. The mean function return always double values, so it implements only the IDoubleSource interface.

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 inherited from interface jas.statistics.IDoubleSource

DEFAULT

Constructor Summary

MovingAverageTraceFunction(IDoubleSource source, int valueID, int windowSize)
Create a basic statistic probe on a IDblSource object.

MovingAverageTraceFunction(IFloatSource source, int valueID, int windowSize)
Create a basic statistic probe on a IDblSource object.

MovingAverageTraceFunction(IIntSource source, int valueID, int windowSize)
Create a basic statistic probe on a IDblSource object.

MovingAverageTraceFunction(ILongSource source, int valueID, int windowSize)
Create a basic statistic probe on a IDblSource object.

Method Summary

void	applyFunction() Collect a value from the source.
double	getDoubleValue(int valueID) Return the result of a given statistic.
void	performAction(int actionType) ISimEventListener callback function.

Methods inherited from class jas.statistics.functions.AbstractFunction

isCheckingTime, setCheckingTime, updateSource

Methods inherited from class java.lang.Object

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

Constructor Detail

MovingAverageTraceFunction

public MovingAverageTraceFunction(IDoubleSource source,
                                  int valueID,
                                  int windowSize)

Create a basic statistic probe on a IDblSource object.

Parameters:

name - Name of the statistic object.

source - The IDblSource object.

valueID - The value identifier defined by source object.

MovingAverageTraceFunction

public MovingAverageTraceFunction(IFloatSource source,
                                  int valueID,
                                  int windowSize)

Create a basic statistic probe on a IDblSource object.

Parameters:

name - Name of the statistic object.

source - The IDblSource object.

valueID - The value identifier defined by source object.

MovingAverageTraceFunction

public MovingAverageTraceFunction(IIntSource source,
                                  int valueID,
                                  int windowSize)

Create a basic statistic probe on a IDblSource object.

Parameters:

name - Name of the statistic object.

source - The IDblSource object.

valueID - The value identifier defined by source object.

MovingAverageTraceFunction

public MovingAverageTraceFunction(ILongSource source,
                                  int valueID,
                                  int windowSize)

Create a basic statistic probe on a IDblSource object.

Parameters:

name - Name of the statistic object.

source - The IDblSource object.

valueID - The value identifier defined by source object.

Method Detail

applyFunction

public void applyFunction()

Collect a value from the source.

Specified by:

applyFunction in class AbstractFunction

getDoubleValue

public double getDoubleValue(int valueID)

Return the result of a given statistic.

Specified by:

getDoubleValue in interface IDoubleSource

Parameters:

valueID - One of the F_ constants representing available statistics.

Returns:

The computed value.

Throws:

java.lang.UnsupportedOperationException - If the given valueID is not supported.

performAction

public void performAction(int actionType)

ISimEventListener callback function. It supports only jas.engine.Sim.EVENT_UPDATE event.

Specified by:

performAction in interface ISimEventListener

Overrides:

performAction in class AbstractFunction

Parameters:

actionType - The action id. Only jas.engine.Sim.EVENT_UPDATE is supported.

Throws:

java.lang.UnsupportedOperationException - If actionType is not supported.