Record Class ProjectScriptDiagnostic.Details.Timer

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.common.script.ProjectScriptDiagnostic.Details.Timer
Record Components:
rateMs - the configured interval between runs, in milliseconds.
fixedDelay - true waits the full interval after each run finishes; false fires on a clock a long run can fall behind.
All Implemented Interfaces:
ProjectScriptDiagnostic.Details
Enclosing interface:
ProjectScriptDiagnostic.Details

public static record ProjectScriptDiagnostic.Details.Timer(long rateMs, boolean fixedDelay) extends Record implements ProjectScriptDiagnostic.Details
A timer script's cadence.
  • Constructor Details

    • Timer

      public Timer(long rateMs, boolean fixedDelay)
      Creates an instance of a Timer record class.
      Parameters:
      rateMs - the value for the rateMs record component
      fixedDelay - the value for the fixedDelay record component
  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object
    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object
    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.
    • rateMs

      public long rateMs()
      Returns the value of the rateMs record component.
      Returns:
      the value of the rateMs record component
    • fixedDelay

      public boolean fixedDelay()
      Returns the value of the fixedDelay record component.
      Returns:
      the value of the fixedDelay record component