OpenPRA Documentation

scram::Reporter ​

Facilities to report analysis results.

#include <reporter.h>

Public Functions ​

Name
voidReport(const core::RiskAnalysis & risk_an, std::FILE * out, bool indent =true)<br>Reports the results of risk analysis on a model.
voidReport(const core::RiskAnalysis & risk_an, const std::string & file, bool indent =true)<br>A convenience function to generate the report into a file.

Public Functions Documentation ​

function Report ​

cpp
void Report(
    const core::RiskAnalysis & risk_an,
    std::FILE * out,
    bool indent =true
)

Reports the results of risk analysis on a model.

Parameters:

  • risk_an Risk analysis with results.
  • out The report destination stream.
  • indent The flag to indent output for readability.

Exceptions:

  • IOError The write operation has failed.

Precondition: The output destination is used only by this reporter. There is going to be no appending to the stream after the report.

The XML report is formed as a single document.

function Report ​

cpp
void Report(
    const core::RiskAnalysis & risk_an,
    const std::string & file,
    bool indent =true
)

A convenience function to generate the report into a file.

Parameters:

  • risk_an Risk analysis with results.
  • file The output destination.
  • indent The flag to indent output for readability.

Exceptions:

  • IOError The output file is not accessible, or the write operation has failed.

This function overwrites the file.

Updated on 2025-11-11 at 16:51:07 +0000