OpenPRA Documentation

scram::core::Analysis ​

Base abstract class for all analysis with settings.

#include <analysis.h>

Inherits from boost::noncopyable

Inherited by scram::core::EventTreeAnalysis, scram::core::FaultTreeAnalysis, scram::core::ImportanceAnalysis, scram::core::ProbabilityAnalysis, scram::core::RiskAnalysis, scram::core::UncertaintyAnalysis

Public Functions ​

Name
Analysis(Settings settings)
virtual~Analysis() =0<br>Abstract class.
const Settings &settings() const
const std::string &warnings() const
doubleanalysis_time() const
voidAddAnalysisTime(double time)<br>Adds time to the total analysis time.
voidAddWarning(std::string msg)<br>Appends a warning message to the analysis warnings.
Settings &settings()

Public Functions Documentation ​

function Analysis ​

cpp
explicit Analysis(
    Settings settings
)

Parameters:

  • settings Analysis settings for all calculations.

function ~Analysis ​

cpp
virtual ~Analysis() =0

Abstract class.

Pure virtual destructor.

function settings ​

cpp
inline const Settings & settings() const

Return: Analysis settings.

function warnings ​

cpp
inline const std::string & warnings() const

Return: Warnings generated upon analysis.

function analysis_time ​

cpp
inline double analysis_time() const

Return: Time taken by the analysis.

function AddAnalysisTime ​

cpp
inline void AddAnalysisTime(
    double time
)

Adds time to the total analysis time.

Parameters:

  • time Additional time spent on analysis.

function AddWarning ​

cpp
inline void AddWarning(
    std::string msg
)

Appends a warning message to the analysis warnings.

Parameters:

  • msg Informative message without special characters.

Warnings are separated by spaces.

function settings ​

cpp
inline Settings & settings()

Return: Modifiable analysis settings.

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