scram

Namespaces

Name
scram::core
scram::env
scram::mef
scram::xml

Classes

	Name
struct	scram::DLError <br>Dynamic library errors.
class	scram::Error <br>The Error class is the base class for all exceptions specific to the SCRAM code.
struct	scram::IllegalOperation <br>This error can be used to indicate that call for a function or operation is not legal.
struct	scram::IOError <br>For input/output related errors.
class	scram::Logger <br>This is a general purpose logger; however, its main usage is asserted to be for debugging.
struct	scram::LogicError <br>Signals internal logic errors, for example, pre-condition failure or use of functionality in ways not designed to.
class	scram::Reporter <br>Facilities to report analysis results.
struct	scram::SettingsError <br>The error in analysis settings.
class	scram::Timer <br>Automatic (scoped) timer to log process duration.
struct	scram::VersionError <br>The minimum required version is not satisfied.

Types

	Name
enum	LogLevel { ERROR = 0, WARNING, INFO, DEBUG1, DEBUG2, DEBUG3, DEBUG4, DEBUG5}<br>Levels for log statements.
using boost::error_info< struct tag_value, std::string >	errinfo_value <br>The generic tag to carry an erroneous value.

Functions

	Name
void	Reporter::ReportCalculatedQuantity< core::FaultTreeAnalysis >(const core::Settings & settings, xml::StreamElement * information)<br>Describes the fault tree analysis and techniques.
void	Reporter::ReportCalculatedQuantity< core::ProbabilityAnalysis >(const core::Settings & settings, xml::StreamElement * information)<br>Describes the probability analysis and techniques.
void	Reporter::ReportCalculatedQuantity< core::ImportanceAnalysis >(const core::Settings & , xml::StreamElement * information)<br>Describes the importance analysis and techniques.
void	Reporter::ReportCalculatedQuantity< core::UncertaintyAnalysis >(const core::Settings & settings, xml::StreamElement * information)<br>Describes the uncertainty analysis and techniques.
void	Reporter::ReportCalculatedQuantity< core::RiskAnalysis >(const core::Settings & settings, xml::StreamElement * information)<br>Describes all performed analyses deduced from settings.

Attributes

	Name
const int	kMaxVerbosity <br>The index of the last level.

Types Documentation

enum LogLevel

Enumerator	Value	Description
ERROR	0	Non-critical errors only.
WARNING		Warnings for users, such as assumptions and corrections.
INFO		Information for users, such as running time and complexity.
DEBUG1		Minimal debugging information.
DEBUG2		Debugging information for the code inside of DEBUG1.
DEBUG3		Debugging information for the code inside of DEBUG2.
DEBUG4		Debugging information for the code inside of DEBUG3.
DEBUG5		Debugging information for the code inside of DEBUG4.

Levels for log statements.

using errinfo_value

cpp

using scram::errinfo_value = typedef boost::error_info<struct tag_value, std::string>;

The generic tag to carry an erroneous value.

Use this tag only if another more-specific error tag is not available.

Functions Documentation

function Reporter::ReportCalculatedQuantity< core::FaultTreeAnalysis >

cpp

void Reporter::ReportCalculatedQuantity< core::FaultTreeAnalysis >(
    const core::Settings & settings,
    xml::StreamElement * information
)

Describes the fault tree analysis and techniques.

function Reporter::ReportCalculatedQuantity< core::ProbabilityAnalysis >

cpp

void Reporter::ReportCalculatedQuantity< core::ProbabilityAnalysis >(
    const core::Settings & settings,
    xml::StreamElement * information
)

Describes the probability analysis and techniques.

function Reporter::ReportCalculatedQuantity< core::ImportanceAnalysis >

cpp

void Reporter::ReportCalculatedQuantity< core::ImportanceAnalysis >(
    const core::Settings & ,
    xml::StreamElement * information
)

Describes the importance analysis and techniques.

function Reporter::ReportCalculatedQuantity< core::UncertaintyAnalysis >

cpp

void Reporter::ReportCalculatedQuantity< core::UncertaintyAnalysis >(
    const core::Settings & settings,
    xml::StreamElement * information
)

Describes the uncertainty analysis and techniques.

function Reporter::ReportCalculatedQuantity< core::RiskAnalysis >

cpp

void Reporter::ReportCalculatedQuantity< core::RiskAnalysis >(
    const core::Settings & settings,
    xml::StreamElement * information
)

Describes all performed analyses deduced from settings.

Attributes Documentation

variable kMaxVerbosity

cpp

const int kMaxVerbosity = 7;

The index of the last level.

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

scram ​

Namespaces ​

Classes ​

Types ​

Functions ​

Attributes ​

Types Documentation ​

enum LogLevel ​

using errinfo_value ​

Functions Documentation ​

function Reporter::ReportCalculatedQuantity< core::FaultTreeAnalysis > ​

function Reporter::ReportCalculatedQuantity< core::ProbabilityAnalysis > ​

function Reporter::ReportCalculatedQuantity< core::ImportanceAnalysis > ​

function Reporter::ReportCalculatedQuantity< core::UncertaintyAnalysis > ​

function Reporter::ReportCalculatedQuantity< core::RiskAnalysis > ​

Attributes Documentation ​

variable kMaxVerbosity ​