Struct SetElectricalComponentPowerRequest 

pub struct SetElectricalComponentPowerRequest {
    pub electrical_component_id: u64,
    pub power_type: i32,
    pub power: f32,
    pub request_lifetime: Option<u64>,
}

Request parameters for the RPC SetElectricalComponentPower.

Fields

electrical_component_id: u64

The ID of the electrical component to set the output power of.

power_type: i32

The requested power type.

power: f32

The requested power output.

For Active power:

• This value is in watts (W).
• Negative values indicate discharge, i.e., supplying power towards the direction of the root node of the component graph.
• Positive values indicate charge, i.e., consuming power from the direction of the root node of the component graph.

For Reactive power:

• This value is in volt-amperes reactive (VAR).
• Negative values indicate capacitive reactive power, i.e., the current is leading the voltage when viewed from the perspective of the electrical component.
• Positive values indicate inductive reactive power, i.e., the current is lagging the voltage when viewed from the perspective of the electrical component.

request_lifetime: Option<u64>

The duration, in seconds, until which the request will stay in effect. This duration has to be between 10 seconds and 15 minutes (including both limits), otherwise the request will be rejected. If not provided, it defaults to 60s.

Implementations

impl SetElectricalComponentPowerRequest

pub fn power_type(&self) -> PowerType

Returns the enum value of power_type, or the default if the field is set to an invalid enum value.

pub fn set_power_type(&mut self, value: PowerType)

Sets power_type to the provided enum value.

pub fn request_lifetime(&self) -> u64

Returns the value of request_lifetime, or the default value if request_lifetime is unset.

Trait Implementations

impl Clone for SetElectricalComponentPowerRequest

fn clone(&self) -> SetElectricalComponentPowerRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SetElectricalComponentPowerRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SetElectricalComponentPowerRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for SetElectricalComponentPowerRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for SetElectricalComponentPowerRequest

fn eq(&self, other: &SetElectricalComponentPowerRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for SetElectricalComponentPowerRequest

impl StructuralPartialEq for SetElectricalComponentPowerRequest