Package cambio.simulator.export

Class AccumulativeDataPointReporter

java.lang.Object

cambio.simulator.export.MiSimReporter<AsyncMultiColumnReportWriter>

cambio.simulator.export.MultiDataPointReporter

cambio.simulator.export.BucketMultiDataPointReporter

cambio.simulator.export.AccumulativeDataPointReporter

public class AccumulativeDataPointReporter
extends BucketMultiDataPointReporter

Accumulates numeric data points. Accumulation is done by adding up all given data per TimeInstant.

Since this Reporter does not know when accumulation The data will be converted to double.

Author:

Lion Wagner

Field Summary

Fields inherited from class cambio.simulator.export.BucketMultiDataPointReporter

bucketingFunction, CEIL_FUNCTION, IDENTITY_FUNCTION

Fields inherited from class cambio.simulator.export.MiSimReporter

datasetsPrefix, model, reportBasePath

Constructor Summary

Constructors

Constructor	Description
AccumulativeDataPointReporter(desmoj.core.simulator.Model model)	Constructs a new data point reporter.
AccumulativeDataPointReporter(desmoj.core.simulator.Model model, UnaryOperator<desmoj.core.simulator.TimeInstant> bucketFunction)	Constructs a new data point reporter.
AccumulativeDataPointReporter(String datasetsPrefix, desmoj.core.simulator.Model model)	Constructs a new data point reporter.
AccumulativeDataPointReporter(String datasetsPrefix, desmoj.core.simulator.Model model, UnaryOperator<desmoj.core.simulator.TimeInstant> bucketFunction)	Constructs a new data point reporter.

Method Summary

Modifier and Type	Method	Description
void	addDatapoint(String dataSetName, desmoj.core.simulator.TimeInstant when, Number data)
final <T> void	addDatapoint(String dataSetName, desmoj.core.simulator.TimeInstant when, T... data)	Adds a new datapoint to the given dataset.
protected AsyncMultiColumnReportWriter	createWriter(Path datasetPath, String[] headers)
void	finalizeReport()	Finalizes the report.
void	flush()	Writes all accumulated data-points to disk.
void	flush(String datasetName)	Writes the given dataset to disk.
void	flush(String datasetName, desmoj.core.simulator.TimeInstant when)	Writes the given TimeInstant (timestamp) of a specific dataset to disk.
void	registerDefaultHeader(String dataSetName, String... headers)	Changes the headers of the given dataset.

Methods inherited from class cambio.simulator.export.MiSimReporter

checkArgumentsAreNotNull, deregister, getWriter, toString

Methods inherited from class java.lang.Object

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

Constructor Details

AccumulativeDataPointReporter

public AccumulativeDataPointReporter(desmoj.core.simulator.Model model)

Constructs a new data point reporter.

See Also:

• BucketMultiDataPointReporter(Model)

AccumulativeDataPointReporter

public AccumulativeDataPointReporter(String datasetsPrefix,
 desmoj.core.simulator.Model model)

Constructs a new data point reporter.

See Also:

• BucketMultiDataPointReporter(String, Model)

AccumulativeDataPointReporter

public AccumulativeDataPointReporter(desmoj.core.simulator.Model model,
 UnaryOperator<desmoj.core.simulator.TimeInstant> bucketFunction)

Constructs a new data point reporter.

See Also:

• BucketMultiDataPointReporter(Model, UnaryOperator)

AccumulativeDataPointReporter

public AccumulativeDataPointReporter(String datasetsPrefix,
 desmoj.core.simulator.Model model,
 UnaryOperator<desmoj.core.simulator.TimeInstant> bucketFunction)

Constructs a new data point reporter.

See Also:

• BucketMultiDataPointReporter(String, Model, UnaryOperator)

Method Details

addDatapoint

public void addDatapoint(String dataSetName,
 desmoj.core.simulator.TimeInstant when,
 Number data)

addDatapoint

@SafeVarargs
public final <T> void addDatapoint(String dataSetName,
 desmoj.core.simulator.TimeInstant when,
 T... data)

Description copied from class: MultiDataPointReporter

Adds a new datapoint to the given dataset.

Overrides:

addDatapoint in class BucketMultiDataPointReporter

Type Parameters:

T - type of the data that should be logged.

Parameters:

dataSetName - name of the dataset to which the datapoint should be added

when - point in simulation time to which the datapoint is associated to

data - data that should be logged

flush

public void flush()

Writes all accumulated data-points to disk.

flush

public void flush(String datasetName)

Writes the given dataset to disk.

flush

public void flush(String datasetName,
 desmoj.core.simulator.TimeInstant when)

Writes the given TimeInstant (timestamp) of a specific dataset to disk.

finalizeReport

public void finalizeReport()

Description copied from class: MiSimReporter

Finalizes the report. This method is called automatically by the SimulationEndEvent. This will flush all writers and deregister this reporter.

Overrides:

finalizeReport in class MiSimReporter<AsyncMultiColumnReportWriter>

See Also:

• MiSimReporters.deregister(MiSimReporter)

registerDefaultHeader

public void registerDefaultHeader(String dataSetName,
 String... headers)

Description copied from class: MiSimReporter

Changes the headers of the given dataset. This can only be done once and has to be done before the first write

Overrides:

registerDefaultHeader in class MiSimReporter<AsyncMultiColumnReportWriter>

Parameters:

dataSetName - name of the dataset for which the header should be changed

headers - new headers for the dataset

createWriter

protected AsyncMultiColumnReportWriter createWriter(Path datasetPath,
 String[] headers)
                                             throws IOException

Overrides:

createWriter in class MultiDataPointReporter

Throws:

IOException