Class SoftSensorExporter.SoftSensorDefinition

java.lang.Object
neqsim.process.mpc.SoftSensorExporter.SoftSensorDefinition
All Implemented Interfaces:
Serializable
Enclosing class:
SoftSensorExporter
public static class SoftSensorExporter.SoftSensorDefinition extends Object implements Serializable
Definition of a soft-sensor.
Since:
3.0
Version:
1.0
Author:
Even Solbraa
See Also:

  • Field Details

  • Constructor Details

    • SoftSensorDefinition

      public SoftSensorDefinition(String name, SoftSensorExporter.SensorType sensorType)
      Construct a soft-sensor definition.
      Parameters:
      name - the sensor name
      sensorType - the sensor type

  • Method Details

    • getName

      public String getName()
      Get the sensor name.
      Returns:
      the name

    • getSensorType

      public SoftSensorExporter.SensorType getSensorType()
      Get the sensor type.
      Returns:
      the type

    • getEquipmentName

      public String getEquipmentName()
      Get the equipment name.
      Returns:
      the equipment name

    • setEquipmentName

      public void setEquipmentName(String equipmentName)
      Set the equipment name.
      Parameters:
      equipmentName - the equipment name

    • getComponentName

      public String getComponentName()
      Get the component name (for composition sensors).
      Returns:
      the component name

    • setComponentName

      public void setComponentName(String componentName)
      Set the component name.
      Parameters:
      componentName - the component name

    • getOutputUnit

      public String getOutputUnit()
      Get the output unit.
      Returns:
      the output unit

    • setOutputUnit

      public void setOutputUnit(String outputUnit)
      Set the output unit.
      Parameters:
      outputUnit - the output unit

    • getDescription

      public String getDescription()
      Get the description.
      Returns:
      the description

    • setDescription

      public SoftSensorExporter.SoftSensorDefinition setDescription(String description)
      Set the description.
      Parameters:
      description - the description
      Returns:
      this definition for method chaining

    • getUpdateRateSeconds

      public double getUpdateRateSeconds()
      Get the update rate in seconds.
      Returns:
      the update rate

    • setUpdateRateSeconds

      public SoftSensorExporter.SoftSensorDefinition setUpdateRateSeconds(double seconds)
      Set the update rate.
      Parameters:
      seconds - update rate in seconds
      Returns:
      this definition for method chaining

    • addInput

      public SoftSensorExporter.SoftSensorDefinition addInput(String inputName, String unit)
      Add an input to this sensor.
      Parameters:
      inputName - the input name
      unit - the input unit
      Returns:
      this definition for method chaining

    • getInputs

      public Map<String,String> getInputs()
      Get the inputs.
      Returns:
      map of input names to units

    • addParameter

      public SoftSensorExporter.SoftSensorDefinition addParameter(String paramName, double value)
      Add a parameter to this sensor.
      Parameters:
      paramName - the parameter name
      value - the parameter value
      Returns:
      this definition for method chaining

    • getParameters

      public Map<String,Double> getParameters()
      Get the parameters.
      Returns:
      map of parameter names to values

    • toMap

      public Map<String,Object> toMap(String tagPrefix)
      Convert to map for JSON export.
      Parameters:
      tagPrefix - the tag prefix
      Returns:
      map representation