Class SteadyStateResult

java.lang.Object
neqsim.process.util.reconciliation.SteadyStateResult
All Implemented Interfaces:
Serializable
public class SteadyStateResult extends Object implements Serializable
Result of a steady-state detection evaluation.

Produced by SteadyStateDetector.evaluate() after checking all monitored variables against R-statistic, slope, and standard-deviation thresholds. Contains an overall verdict and per-variable diagnostics.

Version:
1.0
Author:
Process Optimization Team
See Also:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • variables

      private final List<SteadyStateVariable> variables
      All monitored variables with their current SSD status.

    • atSteadyState

      private boolean atSteadyState
      Whether the overall process is at steady state (all variables pass).

    • steadyCount

      private int steadyCount
      Number of variables at steady state.

    • transientCount

      private int transientCount
      Number of variables not at steady state.

    • transientVariables

      private final List<SteadyStateVariable> transientVariables
      Variables that failed the SSD test.

    • timestamp

      private long timestamp
      Timestamp (epoch ms) of the evaluation.

    • rThreshold

      private double rThreshold
      Minimum R-statistic threshold used.

    • slopeThreshold

      private double slopeThreshold
      Maximum slope threshold used.

  • Constructor Details

    • SteadyStateResult

      public SteadyStateResult(List<SteadyStateVariable> variables, double rThreshold, double slopeThreshold)
      Creates a steady-state detection result.
      Parameters:
      variables - the list of all monitored variables
      rThreshold - the R-statistic threshold used
      slopeThreshold - the slope threshold used

  • Method Details

    • getVariables

      public List<SteadyStateVariable> getVariables()
      Returns all monitored variables.
      Returns:
      unmodifiable list of variables

    • isAtSteadyState

      public boolean isAtSteadyState()
      Returns whether the overall process is at steady state.
      Returns:
      true if all variables are at steady state

    • setAtSteadyState

      void setAtSteadyState(boolean atSteadyState)
      Sets the overall steady-state verdict.
      Parameters:
      atSteadyState - true if all variables pass

    • getSteadyCount

      public int getSteadyCount()
      Returns the number of variables at steady state.
      Returns:
      count of steady-state variables

    • setSteadyCount

      void setSteadyCount(int steadyCount)
      Sets the number of steady-state variables.
      Parameters:
      steadyCount - the count

    • getTransientCount

      public int getTransientCount()
      Returns the number of variables not at steady state.
      Returns:
      count of transient variables

    • setTransientCount

      void setTransientCount(int transientCount)
      Sets the number of transient variables.
      Parameters:
      transientCount - the count

    • getTransientVariables

      public List<SteadyStateVariable> getTransientVariables()
      Returns the variables that failed the SSD test.
      Returns:
      unmodifiable list of transient variables

    • addTransientVariable

      void addTransientVariable(SteadyStateVariable variable)
      Adds a variable to the transient list.
      Parameters:
      variable - the variable that failed the SSD test

    • getTimestamp

      public long getTimestamp()
      Returns the evaluation timestamp.
      Returns:
      epoch milliseconds when evaluate() was called

    • setTimestamp

      void setTimestamp(long timestamp)
      Sets the evaluation timestamp.
      Parameters:
      timestamp - epoch milliseconds

    • getRThreshold

      public double getRThreshold()
      Returns the R-statistic threshold used for this evaluation.
      Returns:
      the R threshold

    • getSlopeThreshold

      public double getSlopeThreshold()
      Returns the slope threshold used for this evaluation.
      Returns:
      the slope threshold

    • toReport

      public String toReport()
      Returns a human-readable summary report.
      Returns:
      formatted text report of the SSD evaluation

    • toJson

      public String toJson()
      Returns a JSON representation of the result.
      Returns:
      JSON string with all SSD data

    • toString

      public String toString()
      Returns a summary string.
      Overrides:
      toString in class Object
      Returns:
      brief summary of the SSD evaluation