Package org.seamcat.model.plugin.system
Interface ConsistencyCheckContext
-
public interface ConsistencyCheckContext
This is used to determine in what context consistency checks are being performed. This is constructed by SEAMCAT when performing consistency checks on the scenario. For each plugin in the scenario SEAMCAT will ensure a correct context is setup and passed in the evaluation.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
add(java.lang.String... path)
void
addError(java.lang.String message)
java.lang.Object
getContextObject()
Gives the specific context object to help identify where in the simulation we are being invoked from.Bounds
getCoverage()
java.util.List<ConsistencyError>
getErrors()
Distribution
getFrequency()
When origin is either SYSTEM or INTERFERENCE_LINK the frequency will return the system frequency or the interference link frequencyInterferenceLink
getInterferenceLink()
When origin is INTERFERENCE_LINK this method returns the interference link configurationOrigin
getOrigin()
Origin describes where this consistency check context originates from.TransceiverSettings
getRxSettings()
Scenario
getScenario()
When origin is EPP the scenario will return the scenario in which this EPP is attachedRadioSystem
getSystem()
When origin is either SYSTEM or INTERFERENCE_LINK the system will be the system or interference link interfererSystemPlugin
getSystemPlugin()
TransceiverSettings
getTxSettings()
void
remove()
void
remove(int count)
ConsistencyCheckContext
setContextObject(java.lang.Object context)
Returns a new Context with the specified context object
-
-
-
Method Detail
-
getOrigin
Origin getOrigin()
Origin describes where this consistency check context originates from. It can be either EPP, SYSTEM, or INTERFERENCE_LINK and depending on which setting the below properties will be set or not- Returns:
- origin of this context
-
getFrequency
Distribution getFrequency()
When origin is either SYSTEM or INTERFERENCE_LINK the frequency will return the system frequency or the interference link frequency- Returns:
- frequency of either system or interference link
-
getSystem
RadioSystem getSystem()
When origin is either SYSTEM or INTERFERENCE_LINK the system will be the system or interference link interferer- Returns:
- radio system of the system or interference link interferer
-
getSystemPlugin
SystemPlugin getSystemPlugin()
-
getInterferenceLink
InterferenceLink getInterferenceLink()
When origin is INTERFERENCE_LINK this method returns the interference link configuration- Returns:
- interference link
-
getScenario
Scenario getScenario()
When origin is EPP the scenario will return the scenario in which this EPP is attached- Returns:
- scenario containing this EPP
-
getContextObject
java.lang.Object getContextObject()
Gives the specific context object to help identify where in the simulation we are being invoked from. For instance an Antenna Plugin can be either configured on a Receiver or Transmitter. So upon invoking consistency check this object will either return a Receiver (if the AP is configured on the Receiver) or a Transmitter (if the AP is configured on the Transmitter).- Returns:
- context specific object
-
setContextObject
ConsistencyCheckContext setContextObject(java.lang.Object context)
Returns a new Context with the specified context object- Parameters:
context
-- Returns:
- Context with the specified context object
-
getCoverage
Bounds getCoverage()
-
getTxSettings
TransceiverSettings getTxSettings()
-
getRxSettings
TransceiverSettings getRxSettings()
-
add
void add(java.lang.String... path)
-
remove
void remove()
-
remove
void remove(int count)
-
getErrors
java.util.List<ConsistencyError> getErrors()
-
addError
void addError(java.lang.String message)
-
-