ClosureDimensionTrait.UnitRangeStruct
class ClosureDimensionTrait.UnitRangeStruct : ClusterStruct
Defines an operational range, from a minimum to a maximum value, for a dimension of a closure.
Summary
Nested types |
|---|
|
Descriptor enum for this struct's fields. |
Public constructors |
|---|
UnitRangeStruct(min: Short, max: Short)Creates the UnitRangeStruct 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 |
|
|---|---|
Short |
The maximum value of the operational range for this dimension, where the unit of measurement is specified by |
Short |
The minimum value of the operational range for this dimension, where the unit of measurement is specified by |
Public constructors
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
max
val max: Short
The maximum value of the operational range for this dimension, where the unit of measurement is specified by ClosureUnitEnum. The value of max must be greater than or equal to the value of min and less than or equal to 32767. The default value is 1.
min
val min: Short
The minimum value of the operational range for this dimension, where the unit of measurement is specified by ClosureUnitEnum. The value of min must be less than or equal to the value of max and greater than or equal to -32768. The default value is 0.