Struct VariableBuilder 

pub struct VariableBuilder<T>
where
    T: FmiVariableBuilder,
{ /* private fields */ }

A builder for creating FMI variables with a fluent interface.

This builder holds all possible FMI variable attributes. The generic type T determines which concrete FMI variable type will be created by finish(). Type-specific finish() implementations will extract only the relevant fields.

Implementations

impl<T> VariableBuilder<T>

where T: FmiVariableBuilder,

pub fn new(name: impl Into<String>, value_reference: fmi3ValueReference) -> Self

Create a new variable builder with the given name.

pub fn with_description(self, description: impl Into<String>) -> Self

Set the description for the variable.

pub fn with_causality(self, causality: Causality) -> Self

Set the causality for the variable.

pub fn with_variability(self, variability: Variability) -> Self

Set the variability for the variable.

pub fn with_can_handle_multiple_set_per_time_instant(self, value: bool) -> Self

Set whether the variable can handle multiple set operations per time instant.

pub fn with_intermediate_update(self, value: bool) -> Self

Set whether the variable can be updated during intermediate update mode.

pub fn with_previous(self, value_reference: u32) -> Self

Set the value reference of the variable that provides the previous value.

pub fn with_declared_type(self, type_name: impl Into<String>) -> Self

Set the declared type name from TypeDefinitions.

pub fn with_initial(self, initial: Initial) -> Self

Set the initial attribute for the variable.

pub fn with_start(self, start: impl Into<T::Start>) -> Self

Set the start value for the variable.

pub fn with_derivative(self, derivative_vr: u32) -> Self

Set the derivative relationship for the variable (value reference of state variable).

pub fn with_reinit(self, reinit: bool) -> Self

Set whether the variable can be reinitialized during event mode.

pub fn with_min(self, min: f64) -> Self

Set the minimum value for the variable (float types).

pub fn with_max(self, max: f64) -> Self

Set the maximum value for the variable (float types).

pub fn with_nominal(self, nominal: f64) -> Self

Set the nominal value for the variable (float types).

pub fn with_quantity(self, quantity: impl Into<String>) -> Self

Set the quantity for the variable (integer types).

pub fn with_dimensions(self, dimensions: Vec<Dimension>) -> Self

Add dimensions to the variable (for array types).

pub fn with_max_size(self, max_size: usize) -> Self

Set the maximum size for binary variables.

pub fn with_mime_type(self, mime_type: impl Into<String>) -> Self

Set the MIME type for binary variables.

pub fn with_clocks(self, clocks: Vec<u32>) -> Self

Set the clocks that this variable belongs to.

pub fn finish(self) -> T::Var

Build the final FMI variable.

This delegates to the type-specific finish implementation which will extract only the relevant fields for the concrete variable type.