jas.statistics.functions
Class MultiTraceFunction.Double

java.lang.Object
  jas.statistics.functions.MultiTraceFunction
      jas.statistics.functions.MultiTraceFunction.Double

All Implemented Interfaces:

ISimEventListener, IDoubleSource, IUpdatableSource

Enclosing class:

MultiTraceFunction

public static class MultiTraceFunction.Double
extends MultiTraceFunction

An implementation of the MemorylessSeries class, which manages double type data sources.

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

Nested Class Summary

Nested classes/interfaces inherited from class jas.statistics.functions.MultiTraceFunction

MultiTraceFunction.Double, MultiTraceFunction.Float, MultiTraceFunction.Integer, MultiTraceFunction.Long

Field Summary

Fields inherited from class jas.statistics.functions.MultiTraceFunction

COUNT, LAST_VALUE, MAX, MEAN, MIN, SUM, VARIANCE

Fields inherited from interface jas.statistics.IDoubleSource

DEFAULT

Constructor Summary

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

MultiTraceFunction.Double(java.lang.Object source, java.lang.String valueName, boolean getFromMethod)
Create a basic statistic probe on a generic object.

Method Summary

double	getDoubleValue(int valueID) Return the result of a given statistic.
double	getLastValue() Return the last double value read from the source object.
double	getMax() The maximum function.
double	getMean() The mean function.
double	getMin() The minimum function.
double	getSum() The sum function.
double	getVariance() The variance function.
void	updateSource() Read the source values and update statistics.

Methods inherited from class jas.statistics.functions.MultiTraceFunction

getCount, performAction

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiTraceFunction.Double

public MultiTraceFunction.Double(IDoubleSource source,
                                 int valueID)

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.

MultiTraceFunction.Double

public MultiTraceFunction.Double(java.lang.Object source,
                                 java.lang.String valueName,
                                 boolean getFromMethod)

Create a basic statistic probe on a generic object.

Parameters:

name - Name of the statistic object.

source - A generic source object.

valueName - The name of the field or the method returning the variable to be probed.

getFromMethod - Specifies if valueName is a method or a property value.

Method Detail

getDoubleValue

public double getDoubleValue(int valueID)

Return the result of a given statistic.

Specified by:

getDoubleValue in interface IDoubleSource

Overrides:

getDoubleValue in class MultiTraceFunction

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.

getLastValue

public double getLastValue()

Return the last double value read from the source object.

Returns:

A double value collected at the last reading operation.

getMax

public double getMax()

The maximum function.

Returns:

The maximum value.

getMean

public double getMean()

The mean function.

Specified by:

getMean in class MultiTraceFunction

Returns:

The mean value.

getMin

public double getMin()

The minimum function.

Returns:

The minimum value.

getSum

public double getSum()

The sum function.

Returns:

The sum of collected values.

getVariance

public double getVariance()

The variance function.

Specified by:

getVariance in class MultiTraceFunction

Returns:

The variance value.

updateSource

public void updateSource()

Read the source values and update statistics.

Specified by:

updateSource in interface IUpdatableSource

Overrides:

updateSource in class MultiTraceFunction