MoleculeReader

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

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 [org.apache.commons.math3.stat.descriptive.UnivariateStatistic] to use for
        aggregating data. If an empty list is passed, then the values
        will be logged independently for each node.
precision

the number of decimal digits to use when writing the output, null for no rounding

Constructors

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

Properties

Link copied to clipboard
open override val columnName: String

The name of the column in the output file.

Link copied to clipboard
open override val columnNames: List<String>

The names of the properties that this Extractor can provide as columns.

Link copied to clipboard

Functions

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

Extracts properties from an environment.

Link copied to clipboard
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.

Link copied to clipboard
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.