LogicalMeterHandle

frequenz_microgrid

Struct LogicalMeterHandle 

Source 
pub struct LogicalMeterHandle { /* private fields */ }
Expand description

This provides an interface stream high-level metrics from a microgrid.

Implementations§

Source§

impl LogicalMeterHandle

Source

pub async fn try_new( client: MicrogridClientHandle, config: LogicalMeterConfig, ) -> Result<Self, Error>

Creates a new LogicalMeter instance.

Source

pub fn grid<M: Metric>( &mut self, metric: M, ) -> Result<Formula<M::QuantityType>, Error>

Returns a receiver that streams samples for the given metric at the grid connection point.

Source

pub fn battery<M: Metric>( &mut self, component_ids: Option<BTreeSet<u64>>, metric: M, ) -> Result<Formula<M::QuantityType>, Error>

Returns a receiver that streams samples for the given metric for the given battery IDs.

When component_ids is None, all batteries in the microgrid are used.

Source

pub fn chp<M: Metric>( &mut self, component_ids: Option<BTreeSet<u64>>, metric: M, ) -> Result<Formula<M::QuantityType>, Error>

Returns a receiver that streams samples for the given metric for the given CHP IDs.

When component_ids is None, all CHPs in the microgrid are used.

Source

pub fn pv<M: Metric>( &mut self, component_ids: Option<BTreeSet<u64>>, metric: M, ) -> Result<Formula<M::QuantityType>, Error>

Returns a receiver that streams samples for the given metric for the given PV IDs.

When component_ids is None, all PVs in the microgrid are used.

Source

pub fn ev_charger<M: Metric>( &mut self, component_ids: Option<BTreeSet<u64>>, metric: M, ) -> Result<Formula<M::QuantityType>, Error>

Returns a receiver that streams samples for the given metric for the given EV charger IDs.

When component_ids is None, all EV chargers in the microgrid are used.

Source

pub fn consumer<M: Metric>( &mut self, metric: M, ) -> Result<Formula<M::QuantityType>, Error>

Returns a receiver that streams samples for the given metric for the logical consumer in the microgrid.

Source

pub fn producer<M: Metric>( &mut self, metric: M, ) -> Result<Formula<M::QuantityType>, Error>

Returns a receiver that streams samples for the given metric for the logical producer in the microgrid.

Source

pub fn component<M: Metric>( &mut self, component_id: u64, metric: M, ) -> Result<Formula<M::QuantityType>, Error>

Returns a receiver that streams samples for the given metric for the given component ID.

Trait Implementations§

Source§

impl Clone for LogicalMeterHandle

Source§

fn clone(&self) -> LogicalMeterHandle

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. 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<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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
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 = Infallible

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.
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