kitControl-EnumLatch

This component provides a latch for a status Enum input. It has the same properties and actions as all the latch components.

kitControl-EnumLatch is available in the Latches folder of the kitControl palette.

Figure 1. EnumLatch properties


PropertyValueDescription
FacetsConfig Facets window (defaults to blank)Defines a range of enumerated states (enum values).This configuration applies to the Out property value.
Clocktrue and false (default) and null definitionTriggers the component to capture and send the In value to the Out value at the moment this property changes from false to true. Nothing happens when it changes from true to false. This is called “latching the input property to the output property on the rising edge.”

When null is checked, the value displayed defaults to the incoming value from the device.If you remove the check mark you can configure the In value.

Outread-only enumerated value (defaults to 0)Contains the value that is captured from the In property at latch time. You link to this property to display the value on a graphic or to process the value with another component.
Innumber (defaults to 0) and null definitionContains the value to pass to Out. You link to this property from a data source, such as from a control point or a Schedule output.

When null is checked, the value displayed defaults to the incoming value from the device.If you remove the check mark you can configure the In value.

Latch action

Latching triggers the component to capture the In value and send it to the Out value. In addition to the Clock property’s role in triggering a latch, you invoke this action:

  • Manually, by right-clicking the latch component and clicking Actions > Latch.

  • Automatically, by linking a Boolean value to the latch action slot on a Latch component. Any change of the Boolean status value invokes a latch action (false to true or true to false). This is in contrast to using the Clock property, which causes the component to latch only when its status changes from false to true.

The Latch action captures the input value any time that the Latch command is invoked.