bcds.phison.sim
Interface StatsExporter

All Superinterfaces:

WithEnvParams

All Known Implementing Classes:

StatsExporterBase, SxSeriesToGnuPlot, SxStdoutBasic

public interface StatsExporter
extends WithEnvParams

The StatsExporter interface defines the methods that must be implemented so that a class can be treated as an statistics exporter of values in a SimStatsCollector object. Classes implementing this interface can be viewed as modules for PHISON's Sim. For that to work, they must provide a default constructor, and perform all their initialization in the setup method.

An statistics exporter class has environment parameters that callers can use to alter its behaviour. The main method is run.

Each class must state clearly whether the values of environment parameters are cached in setup or not.

Author:

Juan Segovia S.

Method Summary

void	run() Performs the actions for which the class is designed.
void	setup(SimStatsCollector stats, Environ env) (Re)initializes an instance.

Methods inherited from interface bcds.phison.WithEnvParams

getEnviron, getEnvParams, getName

Method Detail

setup

void setup(SimStatsCollector stats,
           Environ env)

(Re)initializes an instance. Validates the environment parameters and leaves the object as if it has just been instantiated.

run

void run()

Performs the actions for which the class is designed. Whether is method can be called multiple times depends on each class.