de.zmt.output.collector

Interface Collector

All Superinterfaces:

Serializable

All Known Implementing Classes:

StrategyCollector

public interface Collector
extends Serializable

Collects data from simulation objects to be further processed in Output.

Field Summary

Fields

Modifier and Type	Field and Description
static Collector	EMPTY An empty Collector that does nothing.

Method Summary

Modifier and Type	Method and Description
void	collect(SimState state) Collects data.
default OutputWriter	createWriter(Path outputPath) Returns fitting OutputWriter for this collector.
default String	getName() Returns the name of this collector.

Field Detail

EMPTY

static final Collector EMPTY

An empty Collector that does nothing.

Method Detail

collect

void collect(SimState state)

Collects data. Called for each created CollectMessage.

Parameters:

state - the simulation state

createWriter

default OutputWriter createWriter(Path outputPath)

Returns fitting OutputWriter for this collector. Default implementation is to return OutputWriter.EMPTY.

Parameters:

outputPath - the output path

Returns:

a OutputWriter for this collector

getName

default String getName()

Returns the name of this collector. Used in GUI display when creating inspectors. The default is to return the simple class name. Implementing classes may return a more human-readable and well-formed one.

Returns:

the name of this collector