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 to EventProcessingPlugin but will not be included in the final result. Otherwise if intermediate is false the result will be included in the final result.
    • Method Detail

      • add

        void add​(MultiValueDef def,
                 Point2D plot)
        collect a MultiValueDef of type ScatterPlot
        Parameters:
        def - the definition of the point
        plot - the actual point to collect
      • add

        void add​(MultiValueDef def,
                 BarChartValue value)
        Collect a MultiValueDef of type BarChart
        Parameters:
        def - the definition and identifier of this chart
        value - name and value of the bar chart
      • add

        void add​(MultiValueDef def,
                 LinkResult linkResult)
        Collect a MultiValueDef of type LinkResult
        Parameters:
        def - definition of this collection
        linkResult - value to be collected
      • add

        void add​(VectorDef definition,
                 double value)
        Collect a vector point
        Parameters:
        definition - definition of the vector
        value - 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 points
        values - 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
      • add

        void add​(UniqueValueDef definition,
                 double value)
        Add a unique value definition and value
      • add

        void add​(UniqueValueDef definition,
                 int value)
        Add a unique value definition and value
      • add

        void add​(UniqueValueDef definition,
                 long value)
        Add a unique value definition and value
      • add

        void add​(UniqueValueDef definition,
                 java.lang.String value)
      • getVectorDefinitions

        java.util.Set<VectorDef> getVectorDefinitions()
      • getMultiValueDefinitions

        java.util.Set<MultiValueDef> getMultiValueDefinitions()
      • getUniqueValueDefinitions

        java.util.Set<UniqueValueDef> getUniqueValueDefinitions()