Enum Reason 

pub enum Reason {
    Guard {
        rule: GuardRule,
        since: Option<OffsetDateTime>,
    },
    User(UserOverride),
    Plan {
        plan: PlanId,
        slot: Slot,
        marginal_eur_per_kwh: Option<f64>,
    },
    Realtime(RealtimeCause),
    Fallback(FallbackCause),
}

Why a setpoint has the value it has.

The variants are ordered by authority: a Reason::Guard value can never be relaxed by anything below it. Reason::authority makes that order machine-checkable, and hems-realtime asserts it on every tick.

Variants

Guard

A grid or safety rule. Absolute — [BK6-22-300 A1 4.6 S. 3] requires that a network operator’s reduction takes precedence over market-driven control whenever it is the stricter of the two.

Fields

rule: GuardRule

Which rule.

since: Option<OffsetDateTime>

When the rule became active, where that is known.

User(UserOverride)

A person asked for it.

Plan

The optimiser’s plan for this slot.

Fields

plan: PlanId

Which plan.

slot: Slot

Which slot of it.

marginal_eur_per_kwh: Option<f64>

The marginal value of a kilowatt-hour in that slot, in €/kWh.

The price the plan faces in that slot, not a shadow price: a true dual needs a solver that exposes them, and the pure-Rust backend does not. It explains how much the plan cared, and it is what the guard weights a § 14a allocation by.

Realtime(RealtimeCause)

A correction inside the slot the plan could not anticipate.

Fallback(FallbackCause)

No plan was available.

Implementations

impl Reason

pub const fn authority(&self) -> Authority

The authority this reason carries.

pub const fn guard(rule: GuardRule) -> Self

A guard reason without a start time.

pub const fn guard_since(rule: GuardRule, since: OffsetDateTime) -> Self

A guard reason that knows when it started.

Trait Implementations

impl Clone for Reason

fn clone(&self) -> Reason

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Reason

impl Debug for Reason

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Reason

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Reason

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

Formats the value using the given formatter.

impl PartialEq for Reason

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Reason

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 Reason