Class MinimumRuntime

java.lang.Object
com.uc4.api.objects.MinimumRuntime
Direct Known Subclasses:
MaximumRuntime

public class MinimumRuntime extends Object
This class represents the settings for Minimum Runtime.
  • Field Details

    • METHOD_NONE

      protected static final int METHOD_NONE
      See Also:
    • METHOD_FIX

      protected static final int METHOD_FIX
      See Also:
    • METHOD_ERT

      protected static final int METHOD_ERT
      See Also:
    • method

      protected int method
    • fixedValueSeconds

      protected int fixedValueSeconds
    • percentERT

      protected int percentERT
    • dirty

      protected boolean dirty
  • Constructor Details

    • MinimumRuntime

      protected MinimumRuntime()
  • Method Details

    • setMethodNone

      public void setMethodNone()
      The minimum runtime is not supervised.
    • isMethodNone

      public boolean isMethodNone()
      Returns true if the minimum runtime is not supervised.
      Returns:
      Boolean value indicating if the minimum runtime is supervised
    • isMethodFixedValue

      public boolean isMethodFixedValue()
      Returns true if a fixed value is used for the minimum runtime.
      Returns:
      True if a fixed value is used
    • isMethodERT

      public boolean isMethodERT()
      Returns true if the estimated runtime method is used.
      Returns:
      True if ERT method is used
    • setMethodFixedValue

      public void setMethodFixedValue(int seconds)
      Sets a fixed value for the minimum runtime. An action as an ELSE condition must be specified which reacts when runtime falls below the minimum runtime.
      Parameters:
      seconds - Number of seconds for the minimum runtime
    • setMethodERT

      public void setMethodERT(int percent)
      Selects ERT method to monitor the minimum runtime.

      The valid estimated runtime at the time of the task's activation is used as the minimum runtime. An action as an ELSE condition must be specified which reacts when runtime falls below the minimum runtime. A correction value in percent may be specified for ERT for the minimum runtime. The determined value is subtracted from the estimated runtime.

      Parameters:
      percent - Correction value in percent for ERT for the minimum runtime
    • getFixedValue

      public int getFixedValue()
      Returns the fixed value in seconds.
      Returns:
      Fixed value in seconds
    • getPercentERT

      public int getPercentERT()
      Returns the correction value in percent for ERT for the minimum runtime.
      Returns:
      Correction value in percent for ERT for the minimum runtime
    • copy

      public MinimumRuntime copy()
      This method is used to return the copy of the MinimumRuntime Object.
      Returns:
      MinimumRuntime