Enum OperationalMode 

pub enum OperationalMode {
    Unspecified,
    Inactive,
    TelemetryOnly,
    ControlOnly,
    ControlAndTelemetry,
}

The operational mode of a component.

Mirrors the ElectricalComponentOperationalMode enum in the microgrid API. It indicates whether a component is active and operational, and whether it provides telemetry data, accepts control commands, or both.

A component that does not provide telemetry (see Self::provides_telemetry) cannot be a measurement source in a formula, but it can still be used to classify the meter that measures it (e.g. as a PV meter or a CHP meter).

Variants

Unspecified

The operational mode is not explicitly set.

Treated as if the component provides telemetry. A component with an unknown mode stays usable as a measurement source in formulas.

Inactive

The component is inactive and not operational. It does not provide telemetry data, and it does not accept control commands.

TelemetryOnly

The component is active and operational. It only provides telemetry data, and it does not accept control commands.

ControlOnly

The component is active and operational. It only accepts control commands, and it does not provide telemetry data.

ControlAndTelemetry

The component is active and operational. It provides telemetry data and accepts control commands.

Implementations

impl OperationalMode

pub fn provides_telemetry(self) -> bool

Returns true if a component in this mode provides telemetry data.

Self::Unspecified is treated as providing telemetry: when the mode is unknown the component keeps the default behavior of being usable as a measurement source.

Trait Implementations

impl Clone for OperationalMode

fn clone(&self) -> OperationalMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for OperationalMode

impl Debug for OperationalMode

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

Formats the value using the given formatter.

impl Default for OperationalMode

fn default() -> OperationalMode

Returns the “default value” for a type.

impl Display for OperationalMode

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

Formats the value using the given formatter.

impl Eq for OperationalMode

impl PartialEq for OperationalMode

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for OperationalMode