ClosureControlTrait.OverallCurrentStateStruct

class ClosureControlTrait.OverallCurrentStateStruct : ClusterStruct

The current state of the closure.

Summary

Nested types

Descriptor enum for this struct's fields.

Public constructors

Creates the OverallCurrentStateStruct 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 current latch state of the closure.
OptionalValue<ClosureControlTrait.CurrentPositionEnum?>

The current Position state of the closure, as defined in the CurrentPositionEnum.
Boolean?

The current secure state of the closure.
OptionalValue<ClosureControlTrait.ThreeLevelAutoEnum>

The current speed state of the closure, as defined in the ThreeLevelAutoEnum.

Public constructors

OverallCurrentStateStruct

OverallCurrentStateStruct(
    position: OptionalValue<ClosureControlTrait.CurrentPositionEnum?> = OptionalValue.absent(),
    latch: OptionalValue<Boolean?> = OptionalValue.absent(),
    speed: OptionalValue<ClosureControlTrait.ThreeLevelAutoEnum> = OptionalValue.absent(),
    secureState: Boolean? = null
)

Creates the OverallCurrentStateStruct 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 current latch state of the closure. A null value indicates that the state is not known.

position

val position: OptionalValue<ClosureControlTrait.CurrentPositionEnum?>

The current Position state of the closure, as defined in the CurrentPositionEnum.

secureState

val secureState: Boolean?

The current secure state of the closure. A secure state requires the closure to meet both of the following conditions defined by the OverallCurrentStateStruct:

  • If the Positioning feature is supported, then the Position field of OverallCurrentState is FullyClosed.
  • If the MotionLatching feature is supported, then the Latch field of OverallCurrentStateis True.

speed

val speed: OptionalValue<ClosureControlTrait.ThreeLevelAutoEnum>

The current speed state of the closure, as defined in the ThreeLevelAutoEnum.