Class MoleculeReader
-
- All Implemented Interfaces:
-
it.unibo.alchemist.boundary.Extractor
public final class MoleculeReader extends AbstractDoubleExporter
Reads the value of a molecule and logs it.
-
-
Field Summary
Fields Modifier and Type Field Description private final List<String>
columnNames
private final Integer
precision
-
Constructor Summary
Constructors Constructor Description MoleculeReader(String moleculeName, String property, Incarnation<?, ?> incarnation, ExportFilter filter, List<String> aggregatorNames, Integer precision)
MoleculeReader(String moleculeName, String property, Incarnation<?, ?> incarnation, ExportFilter filter, List<String> aggregatorNames)
-
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. -
-
Constructor Detail
-
MoleculeReader
MoleculeReader(String moleculeName, String property, Incarnation<?, ?> incarnation, ExportFilter 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, ExportFilter 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
-
getColumnNames
List<String> getColumnNames()
- Returns:
the name of the properties that this Extractor can provide
-
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
- Returns:
the extracted properties with their names. 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 LinkedHashMap).
-
-
-
-