DeviceEnergyManagementTrait.ModifyForecastRequestCommand.Request

class DeviceEnergyManagementTrait.ModifyForecastRequestCommand.Request : ClusterStruct

The request payload for the ModifyForecastRequest command.

Summary

Nested types

Descriptor enum for this command's request fields.

Public constructors

Creates a request payload for the ModifyForecastRequest command.

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
DeviceEnergyManagementTrait.AdjustmentCauseEnum

The cause of the request from the EMS.
UInt

The ID of the forecast to modify.
List<DeviceEnergyManagementTrait.SlotAdjustmentStruct>

A list of slotAdjustment parameters that should be modified in the corresponding forecast.

Public constructors

Request

Request(
    forecastId: UInt,
    slotAdjustments: List<DeviceEnergyManagementTrait.SlotAdjustmentStruct> = emptyList(),
    cause: DeviceEnergyManagementTrait.AdjustmentCauseEnum = AdjustmentCauseEnum.LocalOptimization
)

Creates a request payload for the ModifyForecastRequest command.

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

cause

val cause: DeviceEnergyManagementTrait.AdjustmentCauseEnum

The cause of the request from the EMS.

forecastId

val forecastId: UInt

The ID of the forecast to modify.

slotAdjustments

val slotAdjustments: List<DeviceEnergyManagementTrait.SlotAdjustmentStruct>

A list of slotAdjustment parameters that should be modified in the corresponding forecast.