Enum SetElectricalComponentPowerRequestStatus 

#[repr(i32)]
pub enum SetElectricalComponentPowerRequestStatus {
    Unspecified = 0,
    Accepted = 1,
    Rejected = 2,
    Failed = 3,
    Success = 4,
    Overridden = 5,
}

Response codes for the SetElectricalComponentPowerActive and SetElectricalComponentPowerReactive RPCs. These codes indicate the ongoing status of the request to set the power of an electrical component.

Often, electrical components are not able to immediately set their output power to the requested value. This can happen due to several reasons, including, but not limited to:

• having to ramp up or down the power output from the current output.
• having to wait for the electrical component to reach a stable state before applying the new power set-point.
• communication latency between the API service and the electrical component.

In such cases, an initial response is sent to the client, indicating that the request has been accepted, and it is followed by a stream of responses indicating the ongoing status of the request.

Variants

Unspecified = 0

Default value. Users are discouraged from using this value.

Accepted = 1

The request has been accepted, and the target power set-point will be applied to the electrical component.

Once the API service has received a request to set the power of an electrical component, it will validate the input parameters immediately. If the parameters are valid, the service will return this code immediately, and then proceed to apply the power set-point to the electrical component.

Rejected = 2

The request has been rejected because of invalid input parameters.

Once the API service has received a request to set the power of an electrical component, it will validate the input parameters immediately. If the parameters are invalid, the service will return this code immediately, and will not apply the power set-point to the electrical component.

Failed = 3

The request has failed midway, and the electrical component is not at the desired power level.

This code indicates that the request to set the power of an electrical component has been accepted, but the service encountered an error while applying the power set-point to the electrical component.

Success = 4

The request has been successfully processed.

Overridden = 5

The request has been overridden by another request.

This could happen if a new request to set the power of an electrical component arrives while the previous request is still being processed.

Implementations

impl SetElectricalComponentPowerRequestStatus

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of SetElectricalComponentPowerRequestStatus.

pub fn from_i32(value: i32) -> Option<SetElectricalComponentPowerRequestStatus>

👎Deprecated:

Use the TryFrom<i32> implementation instead

Converts an i32 to a SetElectricalComponentPowerRequestStatus, or None if value is not a valid variant.

impl SetElectricalComponentPowerRequestStatus

pub fn as_str_name(&self) -> &'static str

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

pub fn from_str_name(value: &str) -> Option<Self>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations

impl Clone for SetElectricalComponentPowerRequestStatus

fn clone(&self) -> SetElectricalComponentPowerRequestStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SetElectricalComponentPowerRequestStatus

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

Formats the value using the given formatter.

impl Default for SetElectricalComponentPowerRequestStatus

fn default() -> SetElectricalComponentPowerRequestStatus

Returns the “default value” for a type.

impl From<SetElectricalComponentPowerRequestStatus> for i32

fn from(value: SetElectricalComponentPowerRequestStatus) -> i32

Converts to this type from the input type.

impl Hash for SetElectricalComponentPowerRequestStatus

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SetElectricalComponentPowerRequestStatus

fn cmp(&self, other: &SetElectricalComponentPowerRequestStatus) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SetElectricalComponentPowerRequestStatus

fn eq(&self, other: &SetElectricalComponentPowerRequestStatus) -> 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 PartialOrd for SetElectricalComponentPowerRequestStatus

fn partial_cmp( &self, other: &SetElectricalComponentPowerRequestStatus, ) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<i32> for SetElectricalComponentPowerRequestStatus

type Error = UnknownEnumValue

The type returned in the event of a conversion error.

fn try_from( value: i32, ) -> Result<SetElectricalComponentPowerRequestStatus, UnknownEnumValue>

Performs the conversion.

impl Copy for SetElectricalComponentPowerRequestStatus

impl Eq for SetElectricalComponentPowerRequestStatus

impl StructuralPartialEq for SetElectricalComponentPowerRequestStatus