de.zmt.output

Class Output

java.lang.Object

de.zmt.output.Output

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, Steppable, sim.portrayal.inspector.ProvidesInspector

public class Output
extends Object
implements Steppable, sim.portrayal.inspector.ProvidesInspector, Closeable

Class for organizing simulation output.

All added Collectors are processed every step or in their associated interval, with their OutputWriter.

This class also implements ProvidesInspector to provide an Inspector which displays each added Collector together with other objects to be inspected that can be added separately.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Output.CollectorOption Output.CollectorOption specify how an added Collector is handled by the Output object where it is added.

Constructor Summary

Constructors

Constructor and Description
Output(Path outputPath) Constructs a new Output instance.

Method Summary

Modifier and Type	Method and Description
boolean	addCollector(Collector collector, Output.CollectorOption... options) Adds a Collector.
void	close()
static String	generateFileName(int index, String first, String... other) Generates a file name from given string and an index number.
static String	generateFileName(String first, String... other) Generates a file name with each given string separated from the other.
Inspector	provideInspector(GUIState state, String name)
void	setOutputPath(Path outputPath) Sets the output path for all associated writers.
void	step(SimState state)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Output

public Output(Path outputPath)

Constructs a new Output instance. Creates a directory at given path.

Parameters:

outputPath - an empty directory where the output gets written to

Method Detail

generateFileName

public static String generateFileName(String first,
                                      String... other)

Generates a file name with each given string separated from the other.

Parameters:

first - the first part

other - the other parts

Returns:

generated file name from parts

generateFileName

public static String generateFileName(int index,
                                      String first,
                                      String... other)

Generates a file name from given string and an index number.

Parameters:

index - the index number, added last

first - the first part

other - the other parts added after the first part

Returns:

generated file name

addCollector

public boolean addCollector(Collector collector,
                            Output.CollectorOption... options)

Adds a Collector.

Parameters:

collector - the collector to be added

options - the options how this collector is handled

Returns:

true (as specified by Collection.add(E))

setOutputPath

public void setOutputPath(Path outputPath)

Sets the output path for all associated writers. Needed to be called during deserialization by the simulation state.

Parameters:

outputPath -

step

public final void step(SimState state)

Specified by:

step in interface Steppable

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

provideInspector

public Inspector provideInspector(GUIState state,
                                  String name)

Specified by:

provideInspector in interface sim.portrayal.inspector.ProvidesInspector

toString

public String toString()

Overrides:

toString in class Object