Skip to main content

OperationModeBuilder

Struct OperationModeBuilder 

Source
pub struct OperationModeBuilder<S: State = Empty> { /* private fields */ }
Expand description

Use builder syntax to set the inputs and finish with build().

Implementations§

Source§

impl<S: State> OperationModeBuilder<S>

Source

pub fn build(self) -> OperationMode
where S: IsComplete,

Finish building and return the requested object

Source

pub fn id(self, value: Id) -> OperationModeBuilder<SetId<S>>
where S::Id: IsUnset,

Required.

Unique within the actuator description that contains it.

The wire spells this field with a capital I — the only field in the whole of S2 JSON that does (erratum E4).

Source

pub fn diagnostic_label( self, value: impl Into<String>, ) -> OperationModeBuilder<SetDiagnosticLabel<S>>
where S::DiagnosticLabel: IsUnset,

Optional (Some / Option setters). Human-readable, for debugging only.

Source

pub fn maybe_diagnostic_label( self, value: Option<impl Into<String>>, ) -> OperationModeBuilder<SetDiagnosticLabel<S>>
where S::DiagnosticLabel: IsUnset,

Optional (Some / Option setters). Human-readable, for debugging only.

Source

pub fn power_ranges( self, value: Vec<PowerRange>, ) -> OperationModeBuilder<SetPowerRanges<S>>
where S::PowerRanges: IsUnset,

Required.

The power in this mode: start at factor 0, end at factor 1.

Source

pub fn supply_range( self, value: NumberRange, ) -> OperationModeBuilder<SetSupplyRange<S>>
where S::SupplyRange: IsUnset,

Required.

The supply rate this mode can deliver, which the CEM matches against the demand. Start at factor 0, end at factor 1.

Source

pub fn running_costs( self, value: NumberRange, ) -> OperationModeBuilder<SetRunningCosts<S>>
where S::RunningCosts: IsUnset,

Optional (Some / Option setters). Cost per second of running in this mode, excluding the commodity. The range expresses uncertainty, not the factor.

Source

pub fn maybe_running_costs( self, value: Option<NumberRange>, ) -> OperationModeBuilder<SetRunningCosts<S>>
where S::RunningCosts: IsUnset,

Optional (Some / Option setters). Cost per second of running in this mode, excluding the commodity. The range expresses uncertainty, not the factor.

Source

pub fn abnormal_condition_only( self, value: bool, ) -> OperationModeBuilder<SetAbnormalConditionOnly<S>>
where S::AbnormalConditionOnly: IsUnset,

Required.

Whether this mode may only be used during an abnormal condition.

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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