Struct EmcBuilder 

pub struct EmcBuilder { /* private fields */ }

Builder for EquationModelCard.

Enforces that all required fields are provided before building.

Implementations

impl EmcBuilder

pub fn new() -> Self

Create a new EMC builder.

pub fn name(self, name: &str) -> Self

Set the EMC name.

pub fn version(self, version: &str) -> Self

Set the version.

pub fn equation(self, equation: &str) -> Self

Set the governing equation (LaTeX).

pub fn class(self, class: EquationClass) -> Self

Set the equation class.

pub fn citation(self, citation: Citation) -> Self

Set the primary citation.

pub fn add_reference(self, reference: Citation) -> Self

Add an additional reference.

pub fn add_variable(self, symbol: &str, name: &str, units: &str) -> Self

Add a variable.

pub fn add_variable_full(self, variable: EquationVariable) -> Self

Add a variable with full specification.

pub fn add_verification_test( self, description: &str, expected: f64, tolerance: f64, ) -> Self

Add a verification test.

pub fn add_verification_test_full(self, test: VerificationTest) -> Self

Add a verification test with full specification.

pub fn add_domain_constraint(self, constraint: DomainConstraint) -> Self

Add a domain constraint.

pub fn add_falsification_criterion( self, criterion: FalsificationCriterion, ) -> Self

Add a falsification criterion.

pub fn add_implementation_note(self, note: ImplementationNote) -> Self

Add an implementation note.

pub fn description(self, description: &str) -> Self

Set the description.

pub fn add_lineage(self, parent: &str) -> Self

Add a parent EMC to the lineage.

pub fn build(self) -> Result<EquationModelCard, String>

Build the EMC, returning an error if required fields are missing.

Required Fields

• name
• equation
• citation
• At least one verification test

Errors

Returns Err with a description of missing fields.

Trait Implementations

impl Debug for EmcBuilder

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

Formats the value using the given formatter.

impl Default for EmcBuilder

fn default() -> EmcBuilder

Returns the “default value” for a type.