AbstractExporter

abstract class AbstractExporter<T, P : Position<P>>(samplingInterval: Double) : Exporter<T, P>

Abstract implementation of a Exporter.

Parameters

samplingInterval

the sampling time, defaults to DEFAULT_INTERVAL.

Inheritors

Constructors

Link copied to clipboard
constructor(samplingInterval: Double)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
lateinit override var dataExtractors: List<Extractor<*>>

The List of Extractor used to export simulations data.

Functions

Link copied to clipboard
override fun bindDataExtractors(dataExtractors: List<Extractor<*>>)

Assign the list of dataExtractors to the selected Exporter.

Link copied to clipboard
override fun bindVariables(variables: Map<String, *>)

Assign the map of variables to the selected Exporter.

Link copied to clipboard
abstract fun close(environment: Environment<T, P>, time: Time, step: Long)

Close the export environment. This method is called when the simulation finishes.

Link copied to clipboard
abstract fun exportData(environment: Environment<T, P>, reaction: Actionable<T>?, time: Time, step: Long)

Delegates the concrete implementation of this method to his subclasses.

Link copied to clipboard
abstract fun setup(environment: Environment<T, P>)

Prepare the export environment. This method is called only once upon simulation initialization.

Link copied to clipboard
override fun update(environment: Environment<T, P>, reaction: Actionable<T>?, time: Time, step: Long)

Every step of the simulation check if is time to export data depending on the sampling interval. Converts the division of the current time and the interval to Long in order to export data only when the difference between steps is as big as the sampling interval.