Package microsim.statistics.weighted

Class Weighted_CrossSection.Float

java.lang.Object

microsim.statistics.weighted.Weighted_CrossSection

microsim.statistics.weighted.Weighted_CrossSection.Float

All Implemented Interfaces:

EventListener, ISourceObjectArray, IUpdatableSource, IWeightedFloatArraySource

Enclosing class:

Weighted_CrossSection

public static class Weighted_CrossSection.Float
extends Weighted_CrossSection
implements IWeightedFloatArraySource

Nested Class Summary

Nested classes/interfaces inherited from class microsim.statistics.weighted.Weighted_CrossSection

Weighted_CrossSection.Double, Weighted_CrossSection.Float, Weighted_CrossSection.Integer, Weighted_CrossSection.Long

Constructor Summary

Constructors

Constructor	Description
Float(java.util.Collection<? extends Weight> source)	Create a statistic probe on a collection of IFloatSource objects.
Float(java.util.Collection<? extends Weight> source, java.lang.Class<? extends Weight> objectClass, java.lang.String valueName, boolean getFromMethod)	Create a basic statistic probe on a collection of objects.
Float(java.util.Collection<? extends Weight> source, java.lang.Enum<?> valueID)	Create a statistic probe on a collection of IFloatSource objects.

Method Summary

Modifier and Type	Method	Description
float[]	getFloatArray()	Return the currently cached array of float values.
double[]	getWeights()
java.lang.String	toString()
void	updateSource()	Force the source to update its currently cached data.

Methods inherited from class microsim.statistics.weighted.Weighted_CrossSection

getFilter, getSourceArray, isCheckingTime, onEvent, setCheckingTime, setFilter

Methods inherited from class java.lang.Object

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

Constructor Detail

Float

public Float(java.util.Collection<? extends Weight> source,
             java.lang.Enum<?> valueID)

Create a statistic probe on a collection of IFloatSource objects.

Parameters:

source - The collection containing IFloatSource object.

valueID - The value identifier defined by source object.

Float

public Float(java.util.Collection<? extends Weight> source)

Create a statistic probe on a collection of IFloatSource objects. It uses the IFloatSource.DEFAULT variable id.

Parameters:

source - The collection containing IFloatSource object.

Float

public Float(java.util.Collection<? extends Weight> source,
             java.lang.Class<? extends Weight> objectClass,
             java.lang.String valueName,
             boolean getFromMethod)

Create a basic statistic probe on a collection of objects.

Parameters:

source - A collection of generic objects.

objectClass - The class of the objects contained by collection source.

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

getFloatArray

public float[] getFloatArray()

Description copied from interface: IWeightedFloatArraySource

Return the currently cached array of float values.

Specified by:

getFloatArray in interface IWeightedFloatArraySource

Returns:

An array of float or a null pointer if the source is empty.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

updateSource

public void updateSource()

Description copied from interface: IUpdatableSource

Force the source to update its currently cached data.

Specified by:

updateSource in interface IUpdatableSource

Specified by:

updateSource in class Weighted_CrossSection

getWeights

public double[] getWeights()

Specified by:

getWeights in interface IWeightedFloatArraySource