alchemist/it.unibo.alchemist.boundary.exporters/CSVExporter

CSVExporter

class CSVExporter<T, P : Position<P>> @JvmOverloads constructor(fileNameRoot: String = "", val interval: Double = DEFAULT_INTERVAL, val exportPath: String = createTempDirectory("alchemist-export") .absolutePathString() .also { logger.warn( "No output folder specified but export required. Alchemist will export data in $it", ) }, val fileExtension: String = "csv", appendTime: Boolean = false) : AbstractExporter<T, P>

Writes data provided by a number of extractors to a CSV file. The CSV uses '#' as the comment character.

Type Parameters

the concentration type

the position type

Constructors

CSVExporter

@JvmOverloads

constructor(fileNameRoot: String = "", interval: Double = DEFAULT_INTERVAL, exportPath: String = createTempDirectory("alchemist-export") .absolutePathString() .also { logger.warn( "No output folder specified but export required. Alchemist will export data in $it", ) }, fileExtension: String = "csv", appendTime: Boolean = false)

Properties

dataExtractors

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

The list of bound data extractors.

exportPath

val exportPath: String

the directory to write exported files (temporary folder is used when omitted)

fileExtension

val fileExtension: String

the extension for the exported files (default: 'csv')

interval

val interval: Double

the sampling time; defaults to AbstractExporter.DEFAULT_INTERVAL

Functions

bindDataExtractors

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

Assign the list of dataExtractors to the selected Exporter.

bindVariables

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

Assign the map of variables to the selected Exporter.

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

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

exportData

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

Delegates the concrete implementation of this method to his subclasses.

setup

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

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

update

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.