Package microsim.statistics.functions

Class MultiTraceFunction.Float

  • All Implemented Interfaces:
    EventListener, IDoubleSource, IFloatSource, IUpdatableSource
    Enclosing class:
    MultiTraceFunction
    public static class MultiTraceFunction.Float
extends MultiTraceFunction
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 and Ross Richardson

    • Constructor Detail

      • Float

        public Float​(IFloatSource source,
             java.lang.Enum<?> valueID)
        Create a basic statistic probe on a IDblSource object.
        Parameters:
        source - The IDblSource object.
        valueID - The value identifier defined by source object.

      • Float

        public Float​(java.lang.Object source,
             java.lang.String valueName,
             boolean getFromMethod)
        Create a basic statistic probe on a generic object.
        Parameters:
        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​(java.lang.Enum<?> 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.

      • getFloatValue

        public float getFloatValue​(java.lang.Enum<?> 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.

      • getVariance

        public double getVariance()
        The variance function.
        Specified by:
        getVariance in class MultiTraceFunction
        Returns:
        The variance value.

      • getLastValue

        public float getLastValue()
        Return the last float value read from the source object.
        Returns:
        A float value collected at the last reading operation.

      • getMax

        public float getMax()
        The maximum function.
        Returns:
        The maximum value.

      • getSum

        public float getSum()
        The sum function.
        Returns:
        The sum of collected values.

      • getMin

        public float getMin()
        The minimum function.
        Returns:
        The minimum value.

      • getMean

        public double getMean()
        The mean function.
        Specified by:
        getMean in class MultiTraceFunction
        Returns:
        The mean value.