Interface MeasurementDeviceInterface

All Superinterfaces:
NamedInterface, Serializable
All Known Implementing Classes:
CombustionEmissionsCalculator, CompressorMonitor, CricondenbarAnalyser, FireDetector, FlowInducedVibrationAnalyser, GasDetector, HydrateEquilibriumTemperatureAnalyser, HydrocarbonDewPointAnalyser, LevelTransmitter, MeasurementDeviceBaseClass, MolarMassAnalyser, MultiPhaseMeter, NMVOCAnalyser, OilLevelTransmitter, pHProbe, PressureTransmitter, PushButton, SevereSlugAnalyser, SoftSensor, StreamMeasurementDeviceBaseClass, TemperatureTransmitter, VirtualFlowMeter, VolumeFlowTransmitter, WaterContentAnalyser, WaterDewPointAnalyser, WaterLevelTransmitter, WellAllocator
public interface MeasurementDeviceInterface extends NamedInterface, Serializable

MeasurementDeviceInterface interface.

Version:
$Id: $Id
Author:
Even Solbraa

  • Method Details

    • displayResult

      void displayResult()

      displayResult.

    • getMeasuredValue

      default double getMeasuredValue()

      getMeasuredValue.

      Returns:
      Get measured value in unit GetUnit()

    • getMeasuredValue

      double getMeasuredValue(String unit)

      Get Measured value in specified unit.

      Parameters:
      unit - a String object
      Returns:
      a double

    • getOnlineSignal

      OnlineSignal getOnlineSignal()

      getOnlineSignal.

      Returns:
      a OnlineSignal object

    • getMeasuredPercentValue

      double getMeasuredPercentValue()

      getMeasuredPercentValue.

      Returns:
      a double

    • getUnit

      String getUnit()

      getUnit.

      Returns:
      a String object

    • setUnit

      void setUnit(String unit)

      setUnit.

      Parameters:
      unit - a String object

    • getMaximumValue

      double getMaximumValue()

      getMaximumValue.

      Returns:
      a double

    • setMaximumValue

      void setMaximumValue(double maximumValue)

      setMaximumValue.

      Parameters:
      maximumValue - a double

    • getMinimumValue

      double getMinimumValue()

      getMinimumValue.

      Returns:
      a double

    • setMinimumValue

      void setMinimumValue(double minimumValue)

      setMinimumValue.

      Parameters:
      minimumValue - a double

    • isLogging

      boolean isLogging()

      isLogging.

      Returns:
      a boolean

    • setLogging

      void setLogging(boolean logging)

      setLogging.

      Parameters:
      logging - a boolean

    • getOnlineValue

      default double getOnlineValue()

      getOnlineValue.

      Returns:
      a double

    • isOnlineSignal

      boolean isOnlineSignal()

      isOnlineSignal.

      Returns:
      a boolean

    • setAlarmConfig

      void setAlarmConfig(AlarmConfig alarmConfig)
      Associates an alarm configuration with the measurement device.
      Parameters:
      alarmConfig - configuration to apply, or null to disable alarms

    • getAlarmConfig

      AlarmConfig getAlarmConfig()
      Returns the alarm configuration, or null if alarms are disabled.
      Returns:
      alarm configuration

    • getAlarmState

      AlarmState getAlarmState()
      Returns the mutable alarm state for the device.
      Returns:
      alarm state

    • evaluateAlarm

      List<AlarmEvent> evaluateAlarm(double measuredValue, double dt, double time)
      Evaluates the alarm state using the supplied measurement value.
      Parameters:
      measuredValue - measured value
      dt - simulation time step
      time - current simulation time
      Returns:
      events generated during the evaluation

    • acknowledgeAlarm

      AlarmEvent acknowledgeAlarm(double time)
      Acknowledges the currently active alarm if one exists.
      Parameters:
      time - simulation time of the acknowledgement
      Returns:
      acknowledgement event, or null if nothing was acknowledged

    • equals

      boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      int hashCode()
      Overrides:
      hashCode in class Object