Struct SimulationReport 

pub struct SimulationReport {
    pub title: String,
    pub description: String,
    pub parameters: HashMap<String, String>,
    pub results: HashMap<String, String>,
    pub sections: Vec<ReportSection>,
    pub figures: Vec<FigureRef>,
    pub tables: Vec<DataTable>,
    pub author: String,
    pub date: String,
    pub version: Option<String>,
}

A complete simulation report aggregating parameters, results, sections, figures, and tables.

Fields

title: String

Report title.

description: String

Short description / abstract.

parameters: HashMap<String, String>

Simulation parameters (key → value string).

results: HashMap<String, String>

Key result values (key → value string).

sections: Vec<ReportSection>

Ordered report sections.

figures: Vec<FigureRef>

Top-level figure references (outside any section).

tables: Vec<DataTable>

Top-level data tables (outside any section).

author: String

Report author.

date: String

Report date.

version: Option<String>

Optional version string.

Implementations

impl SimulationReport

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

Create a new empty report with the given title.

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

Set the description / abstract.

pub fn with_author(self, author: impl Into<String>) -> Self

Set the author.

pub fn with_date(self, date: impl Into<String>) -> Self

Set the date string.

pub fn with_version(self, version: impl Into<String>) -> Self

Set the version string.

pub fn add_parameter( &mut self, key: impl Into<String>, value: impl Into<String>, )

Insert a parameter key-value pair.

pub fn add_result(&mut self, key: impl Into<String>, value: impl Into<String>)

Insert a result key-value pair.

pub fn add_section(&mut self, section: ReportSection)

Append a report section.

pub fn add_figure(&mut self, figure: FigureRef)

Append a top-level figure.

pub fn add_table(&mut self, table: DataTable)

Append a top-level table.

pub fn total_tables(&self) -> usize

Total number of tables across all sections and top-level.

pub fn total_figures(&self) -> usize

Total number of figures across all sections and top-level.

Trait Implementations

impl Clone for SimulationReport

fn clone(&self) -> SimulationReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SimulationReport

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

Formats the value using the given formatter.

impl Default for SimulationReport

fn default() -> SimulationReport

Returns the “default value” for a type.