Skip to main content

Registry

Struct Registry 

Source
pub struct Registry {
Show 14 fields pub details: Option<ResourceManagerDetails>, pub frbc: Option<SystemDescription>, pub ombc: Option<SystemDescription>, pub ddbc: Option<SystemDescription>, pub scheduled: Vec<(Timestamp, Message)>, pub pebc_constraints: Vec<PowerConstraints>, pub pebc_energy: Vec<EnergyConstraint>, pub ppbc_profiles: Vec<PowerProfileDefinition>, pub instructions: Vec<Id>, pub instruction_statuses: Vec<(Id, InstructionStatus)>, pub published: Vec<(RevokableObjects, Id)>, pub active_modes: Vec<(Id, Id)>, pub timers: Vec<TimerState>, pub fill_level: Option<f64>,
}
Expand description

Everything either side has published on this session.

Every table is bounded: a peer cannot grow memory by sending identifiers it never resolves (Registry::MAX_TRACKED).

Fields§

§details: Option<ResourceManagerDetails>

The resource’s details.

§frbc: Option<SystemDescription>

The FRBC system description in force.

§ombc: Option<SystemDescription>

The OMBC system description in force.

§ddbc: Option<SystemDescription>

The DDBC system description in force.

§scheduled: Vec<(Timestamp, Message)>

Descriptions whose valid_from is still in the future.

§pebc_constraints: Vec<PowerConstraints>

Power constraints in force.

§pebc_energy: Vec<EnergyConstraint>

Energy constraints in force.

§ppbc_profiles: Vec<PowerProfileDefinition>

Power profiles published.

§instructions: Vec<Id>

Instruction identifiers used.

§instruction_statuses: Vec<(Id, InstructionStatus)>

The latest status of each instruction.

§published: Vec<(RevokableObjects, Id)>

Objects that could be revoked.

§active_modes: Vec<(Id, Id)>

The operation mode each actuator is in (Id::NIL for OMBC’s single machine).

§timers: Vec<TimerState>

When each actuator’s timers finish, keyed by actuator and timer: a timer identifier is unique only within the description that declares it.

§fill_level: Option<f64>

The present fill level, once a storage status has arrived.

Implementations§

Source§

impl Registry

Source

pub const MAX_TRACKED: usize = 4096

The most identifiers of any one kind that are remembered.

Source

pub const MAX_SCHEDULED: usize = 16

The most descriptions that may be queued for a future valid_from.

Far smaller than MAX_TRACKED because each entry is a whole decoded message rather than an identifier. An eviction drops the description furthest from taking effect.

Source

pub fn record(&mut self, message: &Message, now: Option<Timestamp>)

Record what a message publishes, whichever direction it went.

A description whose valid_from is in the future is held until it becomes effective; Registry::activate_due promotes it.

Source

pub fn activate_due(&mut self, now: Timestamp) -> Vec<Message>

Promote every scheduled description whose time has come.

Source

pub fn next_activation(&self) -> Option<Timestamp>

The earliest scheduled description still waiting.

Source

pub fn revoke(&mut self, object_type: RevokableObjects, object_id: Id)

Withdraw an object.

A system description has no id of its own, so the standard has its message_id stand in (Message::revokable_id). That makes the identifier load-bearing rather than decorative: a Resource Manager that has published description B and then revokes the superseded A must not lose B. So the stored description is cleared only when it is the one named.

Source

pub fn context<'a>( &'a self, profile: WireProfile, sender: EnergyManagementRole, active: Option<ControlType>, s2_connect: bool, now: Timestamp, seen: &'a [Id], skew_tolerance: Duration, ) -> Context<'a>

The validation context this registry supports.

The argument list is long because a Context is: every one of these is a fact a cross-message rule needs and the registry does not own.

Trait Implementations§

Source§

impl Clone for Registry

Source§

fn clone(&self) -> Registry

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Registry

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Registry

Source§

fn default() -> Registry

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more