Struct TimeAxisMetadata 

pub struct TimeAxisMetadata { /* private fields */ }

Public description of the temporal coordinates used by a run.

Every record always has an integer iteration. Physical time remains optional, and its unit is legal only when a physical-coordinate name is configured. Labels are documentation persisted once in metadata.json; they do not change crate::system_state::SimulationTime representation.

Implementations

impl TimeAxisMetadata

pub fn new(iteration_name: impl Into<String>) -> Self

Creates a time-axis declaration with a mandatory iteration label.

Whitespace is retained in the builder and rejected by SystemStateWriterBuilder::create_new_recording, keeping fluent configuration infallible while ensuring persisted labels are never silently normalized.

pub fn with_iteration_unit(self, unit: impl Into<String>) -> Self

Sets the optional unit of the iteration coordinate.

pub fn with_physical_time_name(self, name: impl Into<String>) -> Self

Declares the optional floating-point physical coordinate.

pub fn with_physical_time_unit(self, unit: impl Into<String>) -> Self

Sets the physical-coordinate unit.

A matching TimeAxisMetadata::with_physical_time_name is required; construction fails at SystemStateWriterBuilder::create_new_recording if the unit is configured alone.

pub fn with_physical_axis( self, name: impl Into<String>, unit: impl Into<String>, ) -> Self

Declares the physical-time name and unit together.

Trait Implementations

impl Clone for TimeAxisMetadata

fn clone(&self) -> TimeAxisMetadata

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TimeAxisMetadata

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

Formats the value using the given formatter.

impl Default for TimeAxisMetadata

fn default() -> Self

Uses iteration as the integer-time label and declares no units or physical coordinate.

impl Eq for TimeAxisMetadata

impl PartialEq for TimeAxisMetadata

fn eq(&self, other: &TimeAxisMetadata) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for TimeAxisMetadata