pub struct SystemDescriptionBuilder<S: State = Empty> { /* private fields */ }Expand description
Use builder syntax to set the inputs and finish with build().
Implementations§
Source§impl<S: State> SystemDescriptionBuilder<S>
impl<S: State> SystemDescriptionBuilder<S>
Sourcepub fn build(self) -> SystemDescriptionwhere
S: IsComplete,
pub fn build(self) -> SystemDescriptionwhere
S: IsComplete,
Finish building and return the requested object
Sourcepub fn message_id(self, value: Id) -> SystemDescriptionBuilder<SetMessageId<S>>where
S::MessageId: IsUnset,
pub fn message_id(self, value: Id) -> SystemDescriptionBuilder<SetMessageId<S>>where
S::MessageId: IsUnset,
Sourcepub fn maybe_message_id(
self,
value: Option<Id>,
) -> SystemDescriptionBuilder<SetMessageId<S>>where
S::MessageId: IsUnset,
pub fn maybe_message_id(
self,
value: Option<Id>,
) -> SystemDescriptionBuilder<SetMessageId<S>>where
S::MessageId: IsUnset,
Sourcepub fn valid_from(
self,
value: Timestamp,
) -> SystemDescriptionBuilder<SetValidFrom<S>>where
S::ValidFrom: IsUnset,
pub fn valid_from(
self,
value: Timestamp,
) -> SystemDescriptionBuilder<SetValidFrom<S>>where
S::ValidFrom: IsUnset,
Required.
When this description becomes valid.
Sourcepub fn actuators(
self,
value: Vec<ActuatorDescription>,
) -> SystemDescriptionBuilder<SetActuators<S>>where
S::Actuators: IsUnset,
pub fn actuators(
self,
value: Vec<ActuatorDescription>,
) -> SystemDescriptionBuilder<SetActuators<S>>where
S::Actuators: IsUnset,
Required.
Every actuator. At least one, at most ten.
Sourcepub fn present_demand_rate(
self,
value: NumberRange,
) -> SystemDescriptionBuilder<SetPresentDemandRate<S>>where
S::PresentDemandRate: IsUnset,
pub fn present_demand_rate(
self,
value: NumberRange,
) -> SystemDescriptionBuilder<SetPresentDemandRate<S>>where
S::PresentDemandRate: IsUnset,
Optional (Some / Option setters). The demand that must be satisfied right now.
Required in v0.0.2-beta and absent in v1.0.0, where it became
PresentDemandStatus. The codec enforces whichever the negotiated profile
requires, so this is the one field whose optionality is a function of the version
.
Sourcepub fn maybe_present_demand_rate(
self,
value: Option<NumberRange>,
) -> SystemDescriptionBuilder<SetPresentDemandRate<S>>where
S::PresentDemandRate: IsUnset,
pub fn maybe_present_demand_rate(
self,
value: Option<NumberRange>,
) -> SystemDescriptionBuilder<SetPresentDemandRate<S>>where
S::PresentDemandRate: IsUnset,
Optional (Some / Option setters). The demand that must be satisfied right now.
Required in v0.0.2-beta and absent in v1.0.0, where it became
PresentDemandStatus. The codec enforces whichever the negotiated profile
requires, so this is the one field whose optionality is a function of the version
.
Sourcepub fn provides_average_demand_rate_forecast(
self,
value: bool,
) -> SystemDescriptionBuilder<SetProvidesAverageDemandRateForecast<S>>where
S::ProvidesAverageDemandRateForecast: IsUnset,
pub fn provides_average_demand_rate_forecast(
self,
value: bool,
) -> SystemDescriptionBuilder<SetProvidesAverageDemandRateForecast<S>>where
S::ProvidesAverageDemandRateForecast: IsUnset,
Required.
Whether an AverageDemandRateForecast may follow.