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.
UseCustomCorrelationDefinitions
if custom inputs are needed when calculating the correlation mode
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
allowCoLocation()
Indicates whether thisSystemPlugin
supports co-location or notjava.util.List<CorrelationMode>
getCorrelationModes()
The list of correlation modes supported by thisSystemPlugin
java.util.List<java.lang.String>
getInterfererTargetPointNames()
The list of names of points that can be used as correlation target points when thisSystemPlugin
is an interfering systemjava.util.List<java.lang.String>
getVictimCorrelationPoints()
The list of names of points that can be used as correlation source points when thisSystemPlugin
is a victim systemPoint2D
getVictimPosition(VictimResultCollector collector, java.lang.String correlationPoint)
In the method getVictimCorrelationPoints a list of point names can be chosen as the victim system position.
-
-
-
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 thisSystemPlugin
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 resultscorrelationPoint
- 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 thisSystemPlugin
is an interfering system- Returns:
- list of correlation point names
-
getCorrelationModes
java.util.List<CorrelationMode> getCorrelationModes()
The list of correlation modes supported by thisSystemPlugin
- Returns:
- supported correlation modes
-
allowCoLocation
boolean allowCoLocation()
Indicates whether thisSystemPlugin
supports co-location or not- Returns:
- supports co-location
-
-