net.sourceforge.jabm.report
Class SummaryStatisticsReportVariables

java.lang.Object
  net.sourceforge.jabm.event.AbstractModel
      net.sourceforge.jabm.report.AbstractReportVariables
          net.sourceforge.jabm.report.SummaryStatisticsReportVariables

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, EventListener, Model, Report, ReportVariables, XYReportVariables

public class SummaryStatisticsReportVariables
extends AbstractReportVariables

See Also:

Serialized Form

Field Summary

protected ReportVariables	reportVariables
protected java.util.Map<java.lang.Object,org.apache.commons.math3.stat.descriptive.SummaryStatistics>	summaryVariableBindings

Fields inherited from class net.sourceforge.jabm.report.AbstractReportVariables

name, simulation, timeStamp, xVariableName, yVariableNames

Fields inherited from class net.sourceforge.jabm.event.AbstractModel

deleteQueue, genericListeners, specificListeners

Constructor Summary

SummaryStatisticsReportVariables(AbstractReportVariables reportVariables)

SummaryStatisticsReportVariables(ReportVariables reportVariables)

SummaryStatisticsReportVariables(java.lang.String name, ReportVariables reportVariables)

Method Summary

void	compute(SimEvent event) Update variables.
ReportVariables	getReportVariables()
java.util.Map<java.lang.Object,java.lang.Number>	getVariableBindings() Get the values calculated by this report.
void	initialise(SimEvent event) Initialise the variables in response to event.
void	setReportVariables(ReportVariables reportVariables)

Methods inherited from class net.sourceforge.jabm.report.AbstractReportVariables

createVariable, dispose, eventOccurred, getName, getNumberOfSeries, getTimeStamp, getX, getxVariableName, getY, getyVariableNames, recordMoments, recordSummaryStatistics, setName, tag

Methods inherited from class net.sourceforge.jabm.event.AbstractModel

addListener, addListener, clearListeners, clone, fireEvent, notifyGenericListeners, notifySpecificListeners, processDeleteQueue, removeListener

Methods inherited from class java.lang.Object

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

Field Detail

summaryVariableBindings

protected java.util.Map<java.lang.Object,org.apache.commons.math3.stat.descriptive.SummaryStatistics> summaryVariableBindings

reportVariables

protected ReportVariables reportVariables

Constructor Detail

SummaryStatisticsReportVariables

public SummaryStatisticsReportVariables(AbstractReportVariables reportVariables)

SummaryStatisticsReportVariables

public SummaryStatisticsReportVariables(java.lang.String name,
                                        ReportVariables reportVariables)

SummaryStatisticsReportVariables

public SummaryStatisticsReportVariables(ReportVariables reportVariables)

Method Detail

compute

public void compute(SimEvent event)

Description copied from interface: ReportVariables

Update variables.

Specified by:

compute in interface ReportVariables

Overrides:

compute in class AbstractReportVariables

getVariableBindings

public java.util.Map<java.lang.Object,java.lang.Number> getVariableBindings()

Description copied from interface: Report

Get the values calculated by this report.

Specified by:

getVariableBindings in interface Report

Overrides:

getVariableBindings in class AbstractReportVariables

Returns:

A Map of user-readable variable names to their associated values.

initialise

public void initialise(SimEvent event)

Description copied from interface: ReportVariables

Initialise the variables in response to event.

Specified by:

initialise in interface ReportVariables

Overrides:

initialise in class AbstractReportVariables

getReportVariables

public ReportVariables getReportVariables()

setReportVariables

public void setReportVariables(ReportVariables reportVariables)