Interface Collector
-
- All Known Subinterfaces:
InterfererResultCollector
,VictimResultCollector
public interface Collector
Collector interface used in simulation to collect values which might become part of the total simulation result. The value definition has two modes: intermediate true or false. If intermediate is true the result will only be available toEventProcessingPlugin
but will not be included in the final result. Otherwise if intermediate is false the result will be included in the final result.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
add(MultiValueDef def, Point2D plot)
collect a MultiValueDef of type ScatterPlotvoid
add(MultiValueDef def, LinkResult linkResult)
Collect a MultiValueDef of type LinkResultvoid
add(MultiValueDef def, BarChartValue value)
Collect a MultiValueDef of type BarChartvoid
add(UniqueValueDef definition, double value)
Add a unique value definition and valuevoid
add(UniqueValueDef definition, int value)
Add a unique value definition and valuevoid
add(UniqueValueDef definition, long value)
Add a unique value definition and valuevoid
add(UniqueValueDef definition, java.lang.String value)
void
add(UniqueValueDef def, Function function)
Add a unique value definition and valuevoid
add(VectorDef definition, double value)
Collect a vector pointvoid
add(VectorDef definition, java.util.List<java.lang.Double> values)
Collect sample pointsjava.lang.Double
get(VectorDef def)
Get a vector value by its definition.java.util.List<BarChartValue>
getBarChartValues(MultiValueDef def)
double
getDouble(UniqueValueDef def)
Function
getFunction(UniqueValueDef def)
int
getInt(UniqueValueDef def)
java.util.List<LinkResult>
getLinkResults(MultiValueDef def)
long
getLong(UniqueValueDef def)
java.util.Set<MultiValueDef>
getMultiValueDefinitions()
java.util.List<java.lang.Double>
getSamples(VectorDef definition)
Get the sampled valuesjava.util.List<Point2D>
getScatterPoints(MultiValueDef definition)
java.lang.String
getString(UniqueValueDef def)
java.util.Set<UniqueValueDef>
getUniqueValueDefinitions()
java.util.Set<VectorDef>
getVectorDefinitions()
boolean
hasUniqueValue(UniqueValueDef def)
void
sample(VectorDef definition, double value)
Adds sample value to vector sample.
-
-
-
Method Detail
-
add
void add(MultiValueDef def, Point2D plot)
collect a MultiValueDef of type ScatterPlot- Parameters:
def
- the definition of the pointplot
- the actual point to collect
-
getScatterPoints
java.util.List<Point2D> getScatterPoints(MultiValueDef definition)
-
add
void add(MultiValueDef def, BarChartValue value)
Collect a MultiValueDef of type BarChart- Parameters:
def
- the definition and identifier of this chartvalue
- name and value of the bar chart
-
getBarChartValues
java.util.List<BarChartValue> getBarChartValues(MultiValueDef def)
-
add
void add(MultiValueDef def, LinkResult linkResult)
Collect a MultiValueDef of type LinkResult- Parameters:
def
- definition of this collectionlinkResult
- value to be collected
-
getLinkResults
java.util.List<LinkResult> getLinkResults(MultiValueDef def)
-
add
void add(VectorDef definition, double value)
Collect a vector point- Parameters:
definition
- definition of the vectorvalue
- value of the vector in the given snapshot
-
get
java.lang.Double get(VectorDef def)
Get a vector value by its definition. Returns null if value has not been defined- Parameters:
def
- definition of the vector- Returns:
- value of the vector as collected
-
add
void add(VectorDef definition, java.util.List<java.lang.Double> values)
Collect sample points- Parameters:
definition
- definition of the sample pointsvalues
- sample values
-
sample
void sample(VectorDef definition, double value)
Adds sample value to vector sample.
-
getSamples
java.util.List<java.lang.Double> getSamples(VectorDef definition)
Get the sampled values- Parameters:
definition
- definition of the samples- Returns:
- list of sampled values
-
hasUniqueValue
boolean hasUniqueValue(UniqueValueDef def)
-
add
void add(UniqueValueDef definition, double value)
Add a unique value definition and value
-
getDouble
double getDouble(UniqueValueDef def)
-
add
void add(UniqueValueDef definition, int value)
Add a unique value definition and value
-
getInt
int getInt(UniqueValueDef def)
-
add
void add(UniqueValueDef definition, long value)
Add a unique value definition and value
-
getLong
long getLong(UniqueValueDef def)
-
add
void add(UniqueValueDef definition, java.lang.String value)
-
getString
java.lang.String getString(UniqueValueDef def)
-
add
void add(UniqueValueDef def, Function function)
Add a unique value definition and value
-
getFunction
Function getFunction(UniqueValueDef def)
-
getVectorDefinitions
java.util.Set<VectorDef> getVectorDefinitions()
-
getMultiValueDefinitions
java.util.Set<MultiValueDef> getMultiValueDefinitions()
-
getUniqueValueDefinitions
java.util.Set<UniqueValueDef> getUniqueValueDefinitions()
-
-