Package com.uc4.api.objects

Class MinimumRuntime

  • Direct Known Subclasses:
    MaximumRuntime
    public class MinimumRuntime
extends java.lang.Object
    This class represents the settings for Minimum Runtime.

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected MinimumRuntime()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      MinimumRuntime copy()
      This method is used to return the copy of the MinimumRuntime Object.
      int getFixedValue()
      Returns the fixed value in seconds.
      int getPercentERT()
      Returns the correction value in percent for ERT for the minimum runtime.
      boolean isMethodERT()
      Returns true if the estimated runtime method is used.
      boolean isMethodFixedValue()
      Returns true if a fixed value is used for the minimum runtime.
      boolean isMethodNone()
      Returns true if the minimum runtime is not supervised.
      void setMethodERT​(int percent)
      Selects ERT method to monitor the minimum runtime.
      void setMethodFixedValue​(int seconds)
      Sets a fixed value for the minimum runtime.
      void setMethodNone()
      The minimum runtime is not supervised.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • method

        protected int method

      • fixedValueSeconds

        protected int fixedValueSeconds

      • percentERT

        protected int percentERT

      • dirty

        protected boolean dirty

    • Constructor Detail

      • MinimumRuntime

        protected MinimumRuntime()

    • Method Detail

      • 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