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.
-
Nested Class Summary
Nested classes/interfaces inherited from interface ProjectScriptDiagnostic.Details
ProjectScriptDiagnostic.Details.MessageHandler, ProjectScriptDiagnostic.Details.Schedule, ProjectScriptDiagnostic.Details.Timer -
Constructor Summary
ConstructorsConstructorDescriptionTimer(long rateMs, boolean fixedDelay) Creates an instance of aTimerrecord class. -
Method Summary
Modifier and TypeMethodDescriptionfinal booleanIndicates whether some other object is "equal to" this one.booleanReturns the value of thefixedDelayrecord component.final inthashCode()Returns a hash code value for this object.longrateMs()Returns the value of therateMsrecord component.final StringtoString()Returns a string representation of this record class.
-
Constructor Details
-
Timer
public Timer(long rateMs, boolean fixedDelay) Creates an instance of aTimerrecord class.- Parameters:
rateMs- the value for therateMsrecord componentfixedDelay- the value for thefixedDelayrecord component
-
-
Method Details
-
toString
-
hashCode
-
equals
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 thecomparemethod from their corresponding wrapper classes. -
rateMs
-
fixedDelay
public boolean fixedDelay()Returns the value of thefixedDelayrecord component.- Returns:
- the value of the
fixedDelayrecord component
-