Struct vf_rs::vf::builders::ScenarioBuilder

pub struct ScenarioBuilder<SCENARIODEFINITION, AGENT, SCENARIO> { /* private fields */ }

Builder for Scenario.

Implementations

impl<SCENARIODEFINITION, AGENT, SCENARIO> ScenarioBuilder<SCENARIODEFINITION, AGENT, SCENARIO>

pub fn defined_as<VALUE: Into<Option<SCENARIODEFINITION>>>( self, value: VALUE ) -> Self

The scenario definition for this scenario, for example yearly budget.

pub fn has_beginning<VALUE: Into<Option<DateTime<Utc>>>>( self, value: VALUE ) -> Self

The planned or actual beginning of a flow or process.

pub fn has_end<VALUE: Into<Option<DateTime<Utc>>>>(self, value: VALUE) -> Self

The planned or actual end of a flow or process.

pub fn in_scope_of<VALUE: Into<Vec<AGENT>>>(self, value: VALUE) -> Self

In the context of an agent, a grouping generally used for accounting, reporting.

pub fn name<VALUE: Into<String>>(self, value: VALUE) -> Self

An informal or formal textual identifier for an object. Does not imply uniqueness.

pub fn note<VALUE: Into<Option<String>>>(self, value: VALUE) -> Self

pub fn refinement_of<VALUE: Into<Option<SCENARIO>>>(self, value: VALUE) -> Self

This scenario or plan refines another scenario, often as time moves closer or for more detail.

pub fn build( self ) -> Result<Scenario<SCENARIODEFINITION, AGENT, SCENARIO>, ScenarioBuilderError>

Builds a new Scenario.

Errors

If a required field has not been initialized.

Trait Implementations

impl<SCENARIODEFINITION, AGENT, SCENARIO> Default for ScenarioBuilder<SCENARIODEFINITION, AGENT, SCENARIO>

fn default() -> Self

Returns the “default value” for a type.