36.0.11

alchemist-loading/it.unibo.alchemist.boundary.exporters/AbstractExporter

AbstractExporter

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

Abstract implementation of a Exporter.

Parameters

samplingInterval

the sampling time, defaults to DEFAULT_INTERVAL.

Inheritors

MongoDBExporter

Constructors

AbstractExporter

constructor(samplingInterval: Double)

Types

object Companion

Contains the default values.

Properties

lateinit override var dataExtractors: List<Extractor<*>>

The List of Extractor used to export simulations data.

Functions

bindDataExtractors

override fun bindDataExtractors(dataExtractors: List<Extractor<*>>)

Assign the list of dataExtractors to the selected Exporter.

override fun bindVariables(variables: Map<String, *>)

Assign the map of variables to the selected Exporter.

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

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

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

Delegates the concrete implementation of this method to his subclasses.

abstract fun setup(environment: Environment<T, P>)

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

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.