Record Class TimerTriggerConfig
java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.designer.scripteditor.workspace.ai.config.TimerTriggerConfig
- Record Components:
thread- the thread the timer runs on.mode- how the interval between runs is measured.delay- the interval in milliseconds; positive.
@NullMarked
public record TimerTriggerConfig(TimerTriggerConfig.TimerThread thread, TimerTriggerConfig.TimerMode mode, long delay)
extends Record
The trigger configuration of a timer event script: how often it runs, in what timing mode, and on
which thread.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumHow the interval between runs is measured;toString()is the schema token.static enumWhich thread the timer runs on;toString()is the schema token. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final ConfigSchema<TimerTriggerConfig> The authoritative schema and deserialization for timer trigger configs. -
Constructor Summary
ConstructorsConstructorDescriptionTimerTriggerConfig(TimerTriggerConfig.TimerThread thread, TimerTriggerConfig.TimerMode mode, long delay) Creates an instance of aTimerTriggerConfigrecord class. -
Method Summary
Modifier and TypeMethodDescriptionlongdelay()Returns the value of thedelayrecord component.final booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.mode()Returns the value of themoderecord component.thread()Returns the value of thethreadrecord component.final StringtoString()Returns a string representation of this record class.
-
Field Details
-
SCHEMA
The authoritative schema and deserialization for timer trigger configs.
-
-
Constructor Details
-
TimerTriggerConfig
public TimerTriggerConfig(TimerTriggerConfig.TimerThread thread, TimerTriggerConfig.TimerMode mode, long delay) Creates an instance of aTimerTriggerConfigrecord class.
-
-
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. Reference components are compared withObjects::equals(Object,Object); primitive components are compared with thecomparemethod from their corresponding wrapper classes. -
thread
-
mode
-
delay
-