ClosureControlTrait.OverallTargetStateStruct
class ClosureControlTrait.OverallTargetStateStruct : ClusterStruct
The target state of the closure.
Summary
Nested types |
|---|
@HomeExperimentalGenericApiDescriptor enum for this struct's fields. |
Public constructors |
|---|
OverallTargetStateStruct(Creates the OverallTargetStateStruct 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 desired latching state of the closure. |
OptionalValue<ClosureControlTrait.TargetPositionEnum?> |
The target position that the closure is moving to. |
OptionalValue<ClosureControlTrait.ThreeLevelAutoEnum> |
The desired speed at which the closure should perform the movement toward the target position. |
Public constructors
OverallTargetStateStruct
OverallTargetStateStruct(
position: OptionalValue<ClosureControlTrait.TargetPositionEnum?> = OptionalValue.absent(),
latch: OptionalValue<Boolean?> = OptionalValue.absent(),
speed: OptionalValue<ClosureControlTrait.ThreeLevelAutoEnum> = OptionalValue.absent()
)
Creates the OverallTargetStateStruct 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 desired latching state of the closure. A null value indicates that there is no desired latching state.
position
val position: OptionalValue<ClosureControlTrait.TargetPositionEnum?>
The target position that the closure is moving to. A null value indicates there is no target position.
speed
val speed: OptionalValue<ClosureControlTrait.ThreeLevelAutoEnum>
The desired speed at which the closure should perform the movement toward the target position. If no speed value has yet been set, the server sets one of the speed values defined in ThreeLevelAutoEnum.