Struct Envelope 

pub struct Envelope {
    pub floor: Power,
    pub ceiling: Power,
}

A closed interval of active power, load convention.

floor may be negative (the asset may be required to feed in or discharge) and ceiling may be positive. An empty interval — floor > ceiling — is a real and meaningful outcome: two rules that cannot both be satisfied. It is resolved by Envelope::resolve, which keeps the stricter ceiling, because exceeding a grid limit is worse than falling short of a floor.

Fields

floor: Power

The lowest permitted power.

ceiling: Power

The highest permitted power.

Implementations

impl Envelope

pub const UNBOUNDED: Self

Everything a device could physically do, before any rule applies.

pub const fn new(floor: Power, ceiling: Power) -> Self

An interval.

pub const fn at_most(ceiling: Power) -> Self

Only an upper bound — what a grid limit is.

pub const fn at_least(floor: Power) -> Self

Only a lower bound.

pub const fn exactly(value: Power) -> Self

Exactly one value.

pub fn intersect(self, other: Self) -> Self

The intersection of two intervals — the operation the whole design rests on. Narrowing is the only thing any layer is allowed to do.

pub fn is_empty(self) -> bool

true when no value satisfies both bounds.

pub fn contains(self, value: Power) -> bool

true when value lies inside.

pub fn clamp(self, wanted: Power) -> Power

The value inside the interval closest to wanted.

When the interval is empty the ceiling wins: a grid or safety ceiling is a duty towards someone else, a floor is a comfort promise to the household, and breaking the second is recoverable.

pub fn resolve(self) -> Self

The interval with an empty one collapsed onto its ceiling, so downstream code never has to ask again.

pub fn width(self) -> Power

How much room there is between the bounds, or zero when empty.

Trait Implementations

impl Clone for Envelope

fn clone(&self) -> Envelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Envelope

impl Debug for Envelope

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Envelope

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Envelope

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

Formats the value using the given formatter.

impl PartialEq for Envelope

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Envelope

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Envelope