Interface CorrelationDefinitions

  • All Known Implementing Classes:
    DefaultCorrelationDefinitions

    public interface CorrelationDefinitions

    This interface is part of the description of a SystemPlugin.

    All methods relates to the correlation settings that are possible for this system.

    Use CustomCorrelationDefinitions if custom inputs are needed when calculating the correlation mode
    • Method Detail

      • getVictimCorrelationPoints

        java.util.List<java.lang.String> getVictimCorrelationPoints()
        The list of names of points that can be used as correlation source points when this SystemPlugin is a victim system
        Returns:
        list of correlation point names
      • getVictimPosition

        Point2D getVictimPosition​(VictimResultCollector collector,
                                  java.lang.String correlationPoint)
        In the method getVictimCorrelationPoints a list of point names can be chosen as the victim system position. This method is then invoked with the chosen point name and here it must be mapped to an actual point.
        Parameters:
        collector - victim system collected results
        correlationPoint - name of the position which should be mapped to a point
        Returns:
        point to be used for positioning the interfering system
      • getInterfererTargetPointNames

        java.util.List<java.lang.String> getInterfererTargetPointNames()
        The list of names of points that can be used as correlation target points when this SystemPlugin is an interfering system
        Returns:
        list of correlation point names
      • getCorrelationModes

        java.util.List<CorrelationMode> getCorrelationModes()
        The list of correlation modes supported by this SystemPlugin
        Returns:
        supported correlation modes
      • allowCoLocation

        boolean allowCoLocation()
        Indicates whether this SystemPlugin supports co-location or not
        Returns:
        supports co-location