ModeSelectTrait.ModeOptionStruct

class ModeSelectTrait.ModeOptionStruct : ClusterStruct


Represents the possible mode of the cluster instance.

Summary

Public constructors

ModeOptionStruct(
    label: String,
    mode: UByte,
    semanticTags: List<ModeSelectTrait.SemanticTagStruct>
)

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

Readable text that describes the mode option for the user.

UByte

Identifies the mode option for the supportedModes attribute.

List<ModeSelectTrait.SemanticTagStruct>

A list of semantic tags for the mode option, used to determine the meaning of the mode as defined in a standard- or manufacturer-specific namespace.

Public constructors

ModeOptionStruct

ModeOptionStruct(
    label: String = "",
    mode: UByte,
    semanticTags: List<ModeSelectTrait.SemanticTagStruct> = 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

Readable text that describes the mode option for the user.

mode

val modeUByte

Identifies the mode option for the supportedModes attribute.

semanticTags

val semanticTagsList<ModeSelectTrait.SemanticTagStruct>

A list of semantic tags for the mode option, used to determine the meaning of the mode as defined in a standard- or manufacturer-specific namespace. These values are defined in SemanticTagStruct.