LaundryWasherModeTrait.ModeOptionStruct

class LaundryWasherModeTrait.ModeOptionStruct : ClusterStruct


Describes a mode that may be selected on the device.

Summary

Public constructors

ModeOptionStruct(
    label: String,
    mode: UByte,
    modeTags: List<LaundryWasherModeTrait.ModeTagStruct>
)

Creates the ModeOptionStruct 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

String

Text that describes the mode option and is meant to be read and understood by the user.

UByte

A unique identifier for the mode option.

List<LaundryWasherModeTrait.ModeTagStruct>

A list of tags that are associated with the mode option, which may be used by a device to determine the semantics of a certain mode.

Public constructors

ModeOptionStruct

ModeOptionStruct(
    label: String = "",
    mode: UByte,
    modeTags: List<LaundryWasherModeTrait.ModeTagStruct> = emptyList()
)

Creates the ModeOptionStruct class.

Public functions

getDescriptor

open fun getDescriptor(): StructDescriptor

Returns the descriptor for the struct.

getFieldValueById

open fun getFieldValueById(tagId: UInt): Any?

Returns the value of the field for the given tag ID.

Public properties

label

val labelString

Text that describes the mode option and is meant to be read and understood by the user.

mode

val modeUByte

A unique identifier for the mode option.

modeTags

val modeTagsList<LaundryWasherModeTrait.ModeTagStruct>

A list of tags that are associated with the mode option, which may be used by a device to determine the semantics of a certain mode.