Skip to main content

Site

Struct Site 

Source
pub struct Site {
    pub id: SiteId,
    pub label: String,
    pub location: GeoPoint,
    pub grid: GridConnection,
    pub circuits: Circuits,
    pub assets: Vec<Asset>,
}
Expand description

One installation.

Fields§

§id: SiteId

Fleet-unique identity.

§label: String

A human label.

§location: GeoPoint

Where it is.

§grid: GridConnection

The grid connection.

§circuits: Circuits

The electrical tree.

§assets: Vec<Asset>

Everything behind the connection.

Implementations§

Source§

impl Site

Source

pub fn new( id: SiteId, location: GeoPoint, grid: GridConnection, circuits: Circuits, assets: Vec<Asset>, ) -> Result<Self, SiteError>

Build a site and check that it is internally consistent.

§Errors

SiteError for a duplicate asset name, an asset on an unknown circuit, or a circuit tree that is not a tree.

Source

pub fn validate(&self) -> Result<(), SiteError>

Check the cross-references.

§Errors

SiteError as described on Site::new.

Source

pub fn asset(&self, id: &AssetId) -> Option<&Asset>

One asset by name.

Source

pub fn grid_meters(&self) -> impl Iterator<Item = &Asset>

The assets that are meters of the grid connection point.

Source

pub fn balance_residual( grid: Power, assets: impl IntoIterator<Item = Power>, ) -> Power

How far the measured grid power is from the sum of the measured assets.

With the load convention of crate::units, the site balance is

grid == Σ assets

so a residual that is not near zero means a meter is missing, mis-signed or stale. hems-realtime watches it, and a large residual makes the arbiter fall back to conservative assumptions rather than optimise against a fiction.

Trait Implementations§

Source§

impl Clone for Site

Source§

fn clone(&self) -> Site

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 Site

Source§

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

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

impl<'de> Deserialize<'de> for Site

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Site

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for Site

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Site

Auto Trait Implementations§

§

impl Freeze for Site

§

impl RefUnwindSafe for Site

§

impl Send for Site

§

impl Sync for Site

§

impl Unpin for Site

§

impl UnsafeUnpin for Site

§

impl UnwindSafe for Site

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<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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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, <T as TryFrom<U>>::Error>

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.