ClosureDimensionTrait.DimensionStateStruct
class ClosureDimensionTrait.DimensionStateStruct : ClusterStruct
Describes the current state of a dimension of a composed closure.
Summary
Nested types |
|---|
@HomeExperimentalGenericApiDescriptor enum for this struct's fields. |
Public constructors |
|---|
DimensionStateStruct(Creates the DimensionStateStruct class. |
Public functions |
|
|---|---|
open StructDescriptor |
Returns the descriptor for the struct. |
open Any? |
Returns the value of the field for the given tag ID. |
Public properties |
|
|---|---|
OptionalValue<Boolean?> |
The latching state of the closure. |
OptionalValue<UShort?> |
The position of the closure, expressed as a percentage from 0.00% to 100.00%. |
OptionalValue<ClosureDimensionTrait.ThreeLevelAutoEnum> |
The speed of the closure, as defined in the |
Public constructors
DimensionStateStruct
DimensionStateStruct(
position: OptionalValue<UShort?> = OptionalValue.absent(),
latch: OptionalValue<Boolean?> = OptionalValue.absent(),
speed: OptionalValue<ClosureDimensionTrait.ThreeLevelAutoEnum> = OptionalValue.absent()
)
Creates the DimensionStateStruct class.
Public functions
getDescriptor
@HomeExperimentalGenericApi
open fun getDescriptor(): StructDescriptor
Returns the descriptor for the struct.
getFieldValueById
@HomeExperimentalGenericApi
open fun getFieldValueById(tagId: UInt): Any?
Returns the value of the field for the given tag ID.
Public properties
latch
val latch: OptionalValue<Boolean?>
The latching state of the closure. A null value indicates that the latching state is not known or is not set.
position
val position: OptionalValue<UShort?>
The position of the closure, expressed as a percentage from 0.00% to 100.00%.
speed
val speed: OptionalValue<ClosureDimensionTrait.ThreeLevelAutoEnum>
The speed of the closure, as defined in the ThreeLevelAutoEnum.