it.unibo.alchemist.boundary.Exporter.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of alchemist-loading Show documentation

Alchemist Machinery to load from files

The newest version!

/*
 * Copyright (C) 2010-2023, Danilo Pianini and contributors
 * listed, for each module, in the respective subproject's build.gradle.kts file.
 *
 * This file is part of Alchemist, and is distributed under the terms of the
 * GNU General Public License, with a linking exception,
 * as described in the file LICENSE in the Alchemist distribution's top directory.
 */

package it.unibo.alchemist.boundary

import it.unibo.alchemist.model.Actionable
import it.unibo.alchemist.model.Environment
import it.unibo.alchemist.model.Position
import it.unibo.alchemist.model.Time

/**
 * A generic exporter for the simulation.
 * [T] is the concentration type,
 * [P] is the position type, and
 */
interface Exporter> {

    /**
     *  The List of [Extractor] used to export simulations data.
     */
    val dataExtractors: List>

    /**
     * Assign the list of [dataExtractors] to the selected [Exporter].
     */
    fun bindDataExtractors(dataExtractors: List>)

    /**
     * Assign the map of [variables] to the selected [Exporter].
     */
    fun bindVariables(variables: Map)

    /**
     *  Prepare the export environment.
     *  This method is called only once upon simulation initialization.
     */
    fun setup(environment: Environment)

    /**
     * Main method used by exporters to export data.
     * This method is called at each step of the simulation.
     */
    fun update(environment: Environment, reaction: Actionable?, time: Time, step: Long)

    /**
     * Close the export environment.
     * This method is called when the simulation finishes.
     */
    fun close(environment: Environment, time: Time, step: Long)
}