RvcOperationalStateTrait.ErrorStateStruct

class RvcOperationalStateTrait.ErrorStateStruct

Used to indicate the error state of the device when the RvcOperationStateTrait.Attributes.operationalState attribute is Error.

Summary

Public constructors
ErrorStateStruct(
    errorStateId: UByte,
    errorStateLabel: OptionalValue<String>,
    errorStateDetails: OptionalValue<String>
)

Creates the ErrorStateStruct class.

Public properties
OptionalValue<String>

Details about the error condition.
UByte
OptionalValue<String>

Present only when errorStateId is populated with a vendor-specific error ID.

Public constructors

ErrorStateStruct

ErrorStateStruct(
    errorStateId: UByte,
    errorStateLabel: OptionalValue<String> = OptionalValue.absent(),
    errorStateDetails: OptionalValue<String> = OptionalValue.absent()
)

Creates the ErrorStateStruct class.

Public properties

errorStateDetails

val errorStateDetails: OptionalValue<String>

Details about the error condition.

errorStateId

val errorStateId: UByte

errorStateLabel

val errorStateLabel: OptionalValue<String>

Present only when errorStateId is populated with a vendor-specific error ID.