net.sourceforge.jabm.report
Class InteractionIntervalReport

java.lang.Object
  net.sourceforge.jabm.report.AbstractReport
      net.sourceforge.jabm.report.InteractionIntervalReport

All Implemented Interfaces:

EventListener, Report

Direct Known Subclasses:

FreshInteractionIntervalReport

public class InteractionIntervalReport
extends AbstractReport

A report which samples data regularly in response to an InteractionsFinishedEvent. The data to be sampled is configured by specifying an instance of ReportVariables.

See Also:

ReportVariables

Field Summary

static int	DEFAULT_SAMPLE_INTERVAL
protected int	interactions
protected int	sampleInterval

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

reportVariables

Constructor Summary

InteractionIntervalReport()

InteractionIntervalReport(int sampleInterval)

InteractionIntervalReport(int sampleInterval, ReportVariables reportVariables)

InteractionIntervalReport(ReportVariables reportVariables)

Method Summary

void	eventOccurred(SimEvent event)
int	getSampleInterval()
void	onInteractionsFinished(InteractionsFinishedEvent event)
void	onSimulationFinished(SimEvent event)
void	onSimulationStarting(SimulationStartingEvent event)
void	setSampleInterval(int sampleInterval) Configure the sampling interval for this report.

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

getName, getReportVariables, getVariableBindings, setReportVariables

Methods inherited from class java.lang.Object

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

Field Detail

interactions

protected int interactions

sampleInterval

protected int sampleInterval

DEFAULT_SAMPLE_INTERVAL

public static final int DEFAULT_SAMPLE_INTERVAL

See Also:

Constant Field Values

Constructor Detail

InteractionIntervalReport

public InteractionIntervalReport(int sampleInterval,
                                 ReportVariables reportVariables)

InteractionIntervalReport

public InteractionIntervalReport()

InteractionIntervalReport

public InteractionIntervalReport(int sampleInterval)

InteractionIntervalReport

public InteractionIntervalReport(ReportVariables reportVariables)

Method Detail

eventOccurred

public void eventOccurred(SimEvent event)

Specified by:

eventOccurred in interface EventListener

Overrides:

eventOccurred in class AbstractReport

onSimulationFinished

public void onSimulationFinished(SimEvent event)

onSimulationStarting

public void onSimulationStarting(SimulationStartingEvent event)

onInteractionsFinished

public void onInteractionsFinished(InteractionsFinishedEvent event)

getSampleInterval

public int getSampleInterval()

setSampleInterval

public void setSampleInterval(int sampleInterval)

Configure the sampling interval for this report. The underlying ReportVariables will be updated at the corresponding frequency.

Parameters:

sampleInterval -