BindingTrait.TargetStruct
class BindingTrait.TargetStruct : ClusterStruct
A remote node and endpoint.
Summary
Nested types |
|---|
|
Descriptor enum for this struct's fields. |
Public constructors |
|---|
TargetStruct(Creates the TargetStruct 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<UInt> |
The cluster ID for the client and server on the target endpoint. |
OptionalValue<UShort> |
The remote endpoint to which the local endpoint is bound. |
UByte |
The identifier for the fabric where the target endpoint is located. |
OptionalValue<UShort> |
The target group ID. |
OptionalValue<ULong> |
The remote target node ID. |
Public constructors
TargetStruct
TargetStruct(
node: OptionalValue<ULong> = OptionalValue.absent(),
group: OptionalValue<UShort> = OptionalValue.absent(),
endpoint: OptionalValue<UShort> = OptionalValue.absent(),
cluster: OptionalValue<UInt> = OptionalValue.absent(),
fabricIndex: UByte
)
Creates the TargetStruct 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
cluster
val cluster: OptionalValue<UInt>
The cluster ID for the client and server on the target endpoint.
endpoint
val endpoint: OptionalValue<UShort>
The remote endpoint to which the local endpoint is bound.
fabricIndex
val fabricIndex: UByte
The identifier for the fabric where the target endpoint is located.