Package it.unibo.alchemist.loader.export.extractors

Class MoleculeReader

  • All Implemented Interfaces:
    it.unibo.alchemist.loader.export.Extractor 
    
public final class MoleculeReader
extends AbstractDoubleExporter

    Reads the value of a molecule and logs it.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Method Summary

      Modifier and Type Method Description
      List<String> getColumnNames()
      <T extends Any> Map<String, Double> extractData(Environment<T, ?> environment, Actionable<T> reaction, Time time, Long step) Extracts properties from an environment.

      • Methods inherited from class it.unibo.alchemist.loader.export.extractors.AbstractDoubleExporter

        extractDataAsText, getPrecision

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • MoleculeReader

        MoleculeReader(String moleculeName, String property, Incarnation<?, ?> incarnation, FilteringPolicy filter, List<String> aggregatorNames, Integer precision)
        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.

      • MoleculeReader

        MoleculeReader(String moleculeName, String property, Incarnation<?, ?> incarnation, FilteringPolicy filter, List<String> aggregatorNames)
        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.

    • Method Detail

      • extractData

         <T extends Any> Map<String, Double> extractData(Environment<T, ?> environment, Actionable<T> reaction, Time time, Long step)

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

        • contain a single element,

        • have the keys matching columnNames, or

        • be iterable in predictable order (namely, implement SortedMap or extend one of LinkedHashMap or ConcurrentLinkedHashMap).

        Parameters:
        environment - 
        the {@link Environment}
        reaction - 
        the last executed {@link Reaction}
        time - 
        the current {@link Time}
        step - 
        the simulation step