alchemist-loading/it.unibo.alchemist.boundary.extractors/MoleculeReader

MoleculeReader

class MoleculeReader @JvmOverloads constructor(moleculeName: String, property: String?, incarnation: Incarnation<*, *>, filter: ExportFilter, aggregatorNames: List<String>, precision: Int? = null) : AbstractAggregatingDoubleExporter(source)

Reads the value of a molecule and logs it.

Parameters

moleculeName

the target molecule

property

the target property

incarnation

the target incarnation

filter

the [FilteringPolicy] to use

aggregatorNames

the names of the [UnivariateStatistic] to use for
aggregating data. If an empty list is passed, then the values
will be logged indipendently for each node.

Constructors

MoleculeReader

@JvmOverloads

constructor(moleculeName: String, property: String?, incarnation: Incarnation<*, *>, filter: ExportFilter, aggregatorNames: List<String>, precision: Int? = null)

Properties

columnName

open override val columnName: String

The name of the column in the output file.

columnNames

open override val columnNames: List<String>

precision

val precision: Int?

Functions

extractData

override fun <T> extractData(environment: Environment<T, *>, reaction: Actionable<T>?, time: Time, step: Long): Map<String, Double>

Extracts properties from an environment. The returned map must either:

extractDataAsText

override fun <T> extractDataAsText(environment: Environment<T, *>, reaction: Actionable<T>?, time: Time, step: Long): Map<String, String>

Same as extractData, but specifically meant for textual outputs. Captures E to String conversions. The default implementation just runs a toString() conversion ver extractData's return value's values.

getData

open override fun <T> getData(environment: Environment<T, *>, reaction: Actionable<T>?, time: Time, step: Long): Map<Node<T>, Double>

Delegated to the concrete implementation to extract data from the environment.