TargetNavigatorTrait.TargetInfoStruct

class TargetNavigatorTrait.TargetInfoStruct : ClusterStruct


An object describing the navigable target.

Summary

Nested types

Descriptor enum for this struct's fields.

Public constructors

TargetInfoStruct(identifier: UByte, name: String)

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

UByte

The unique ID within the targetList.

String

The unique name, as a string.

Public constructors

TargetInfoStruct

TargetInfoStruct(identifier: UByte, name: String = "")

Creates the TargetInfoStruct class.

Public functions

getDescriptor

@HomeExperimentalApi
open fun getDescriptor(): StructDescriptor

Returns the descriptor for the struct.

getFieldValueById

@HomeExperimentalApi
open fun getFieldValueById(tagId: UInt): Any?

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

Public properties

identifier

val identifierUByte

The unique ID within the targetList.

name

val nameString

The unique name, as a string.