jas.statistics.functions
Class MaxTraceFunction.Float

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

All Implemented Interfaces:

ISimEventListener, IDoubleSource, IFloatSource, IUpdatableSource

Enclosing class:

MaxTraceFunction

public static class MaxTraceFunction.Float
extends MaxTraceFunction
implements IFloatSource

An implementation of the MemorylessSeries class, which manages float 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.MaxTraceFunction

MaxTraceFunction.Double, MaxTraceFunction.Float, MaxTraceFunction.Integer, MaxTraceFunction.Long

Field Summary

Fields inherited from class jas.statistics.functions.MaxTraceFunction

LAST_VALUE, MAX

Fields inherited from interface jas.statistics.IFloatSource

DEFAULT

Fields inherited from interface jas.statistics.IDoubleSource

DEFAULT

Constructor Summary

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

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

Method Summary

void	applyFunction() Read the source values and update statistics.
double	getDoubleValue(int valueID) Return the result of a given statistic.
float	getFloatValue(int valueID) Return the result of a given statistic.
float	getLastValue() Return the last double value read from the source object.
float	getMax() The maximum function.

Methods inherited from class jas.statistics.functions.MaxTraceFunction

performAction

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

MaxTraceFunction.Float

public MaxTraceFunction.Float(IFloatSource 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.

MaxTraceFunction.Float

public MaxTraceFunction.Float(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

applyFunction

public void applyFunction()

Read the source values and update statistics.

Overrides:

applyFunction in class MaxTraceFunction

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.

getFloatValue

public float getFloatValue(int valueID)

Return the result of a given statistic.

Specified by:

getFloatValue in interface IFloatSource

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 float getLastValue()

Return the last double value read from the source object.

Returns:

A double value collected at the last reading operation.

getMax

public float getMax()

The maximum function.

Returns:

The maximum value.