SS.EngineeringReporting 1.2.0
Typed engineering evidence, stable report sections and cross-references, provenance-bearing unit tables and safe equations, provenance validation, deterministic pagination, accessible HTML/SVG, PDF, JSON and CSV artifacts
Language compatibility: >=1.0.0 <2.0.0
Runtime compatibility: >=1.0.0 <2.0.0
No package dependencies declared.
Public API
export function addDocumentSection(ReportSection[] sections, string id, string title, string body, string[] crossReferences, bool pageBreakBefore)->ReportSection[]Parameters: sections: ReportSection[], id: string, title: string, body: string, crossReferences: string[], pageBreakBefore: bool
export function balanceEvidence(string name, double incoming, double outgoing, double tolerance) -> BalanceEvidenceParameters: name: string, incoming: double, outgoing: double, tolerance: double
export record BalanceEvidence(public string name, public double incoming, public double outgoing, public double absoluteError, public double relativeError, public bool passed)Parameters: name: string, incoming: double, outgoing: double, absoluteError: double, relativeError: double, passed: bool
export function composePaginatedReport(ReportMetadata metadata, ReportSection[] sections, UnitsTableRender[] tables, MathEquationRender[] equations, EvidenceLink[] links, int sectionsPerPage)->PaginatedReportParameters: metadata: ReportMetadata, sections: ReportSection[], tables: UnitsTableRender[], equations: MathEquationRender[], links: EvidenceLink[], sectionsPerPage: int
export function convergenceEvidence(string name, double[] meshSizes, double[] errors) -> ConvergenceEvidenceParameters: name: string, meshSizes: double[], errors: double[]
export record ConvergenceEvidence(public string name, public double[] meshSizes, public double[] errors, public double[] reductionFactors, public bool monotone, public double finestError)Parameters: name: string, meshSizes: double[], errors: double[], reductionFactors: double[], monotone: bool, finestError: double
export function convergenceFigure(ConvergenceEvidence study, int width, int height)->stringParameters: study: ConvergenceEvidence, width: int, height: int
export function engineeringReport(string title, ReferenceEvidence[] references, BalanceEvidence[] balances, ConvergenceEvidence[] convergenceStudies) -> EngineeringReportParameters: title: string, references: ReferenceEvidence[], balances: BalanceEvidence[], convergenceStudies: ConvergenceEvidence[]
export record EngineeringReport(public string title, public ReferenceEvidence[] references, public BalanceEvidence[] balances, public ConvergenceEvidence[] convergenceStudies, public bool valid)Parameters: title: string, references: ReferenceEvidence[], balances: BalanceEvidence[], convergenceStudies: ConvergenceEvidence[], valid: bool
export function evidenceLink(string label, string uri, string digest)->EvidenceLinkParameters: label: string, uri: string, digest: string
export record EvidenceLink(public string label, public string uri, public string digest)Parameters: label: string, uri: string, digest: string
export record MathEquationRender(public string id, public string canonical, public string mathMl, public string provenance)Parameters: id: string, canonical: string, mathMl: string, provenance: string
export record PaginatedReport(public string html, public int pageCount, public int sectionCount, public bool valid, public string diagnostic)Parameters: html: string, pageCount: int, sectionCount: int, valid: bool, diagnostic: string
export function referenceEvidence(string name, double expectedValue, string unitLabel, string source) -> ReferenceEvidenceParameters: name: string, expectedValue: double, unitLabel: string, source: string
export record ReferenceEvidence(public string name, public double expectedValue, public string unitLabel, public string source)Parameters: name: string, expectedValue: double, unitLabel: string, source: string
export function renderMathEquation(string id, string leftHandSide, string relationOperator, string[] rightHandTerms, string provenance)->MathEquationRenderParameters: id: string, leftHandSide: string, relationOperator: string, rightHandTerms: string[], provenance: string
export function renderReport(ReportDocument report)->ReportArtifactsParameters: report: ReportDocument
export function renderUnitsTable(string id, string[] columnNames, string[] unitLabels, double[][] rows, int precisionDigits, string provenance)->UnitsTableRenderParameters: id: string, columnNames: string[], unitLabels: string[], rows: double[][], precisionDigits: int, provenance: string
export record ReportArtifacts(public string html, public string pdf, public string json, public string csv, public string[] figures, public int pageCount)Parameters: html: string, pdf: string, json: string, csv: string, figures: string[], pageCount: int
EngineeringReporting.reportCsv
export function reportCsv(ReportDocument report)->stringParameters: report: ReportDocument
export function reportDocument(ReportMetadata metadata, ReferenceEvidence[] references, BalanceEvidence[] balances, ConvergenceEvidence[] convergenceStudies, EvidenceLink[] evidenceLinks)->ReportDocumentParameters: metadata: ReportMetadata, references: ReferenceEvidence[], balances: BalanceEvidence[], convergenceStudies: ConvergenceEvidence[], evidenceLinks: EvidenceLink[]
export record ReportDocument(public string schema, public ReportMetadata metadata, public ReferenceEvidence[] references, public BalanceEvidence[] balances, public ConvergenceEvidence[] convergenceStudies, public EvidenceLink[] evidenceLinks, public bool valid)Parameters: schema: string, metadata: ReportMetadata, references: ReferenceEvidence[], balances: BalanceEvidence[], convergenceStudies: ConvergenceEvidence[], evidenceLinks: EvidenceLink[], valid: bool
EngineeringReporting.reportHtml
export function reportHtml(ReportDocument report, string[] figures)->stringParameters: report: ReportDocument, figures: string[]
EngineeringReporting.reportJson
export function reportJson(ReportDocument report)->stringParameters: report: ReportDocument
export function reportMetadata(string title, string project, string author, string revision, string issuedOn, int precisionDigits)->ReportMetadataParameters: title: string, project: string, author: string, revision: string, issuedOn: string, precisionDigits: int
export record ReportMetadata(public string title, public string project, public string author, public string revision, public string issuedOn, public int precisionDigits)Parameters: title: string, project: string, author: string, revision: string, issuedOn: string, precisionDigits: int
EngineeringReporting.reportPdf
export function reportPdf(ReportDocument report)->stringParameters: report: ReportDocument
export record ReportProvenanceValidation(public bool valid, public int links, public int requiredReferences, public int missingReferences, public string diagnostic)Parameters: valid: bool, links: int, requiredReferences: int, missingReferences: int, diagnostic: string
export record ReportSection(public string id, public string title, public string body, public string[] crossReferences, public bool pageBreakBefore)Parameters: id: string, title: string, body: string, crossReferences: string[], pageBreakBefore: bool
export record UnitsTableRender(public string id, public string html, public string csv, public int rows, public int columns, public int precisionDigits, public string provenance)Parameters: id: string, html: string, csv: string, rows: int, columns: int, precisionDigits: int, provenance: string
export function validateReportProvenance(EvidenceLink[] links, string[] requiredLabels)->ReportProvenanceValidationParameters: links: EvidenceLink[], requiredLabels: string[]
Documentation version
Language 1.0.0, compiler 1.0.0, runtime 1.0.0. This reference is generated from the official SS documentation so package and language details stay consistent with the release.