OpenPRA Documentation

scram::Project ​

This class processes project configuration files for analysis. More...

#include <project.h>

Public Functions ​

Name
Project(const std::string & project_file)<br>A constructor with project configurations for analysis.
const std::vector< std::string > &input_files() const
const core::Settings &settings() const

Detailed Description ​

cpp
class scram::Project;

This class processes project configuration files for analysis.

The class contains all the setup and state to initialize general analysis.

Public Functions Documentation ​

function Project ​

cpp
explicit Project(
    const std::string & project_file
)

A constructor with project configurations for analysis.

Parameters:

  • project_file The path to the project file with configurations.

Exceptions:

  • VersionError The version required by the file is incompatible.
  • ValidityError The configurations have problems.
  • SettingsError Settings values contain errors.
  • IOError The file is not accessible.

Reads and validates the configurations.

All relative paths in the configuration are resolved with respect to the location of the original configuration file.

function input_files ​

cpp
inline const std::vector< std::string > & input_files() const

Return: normalized, absolute paths to input files for analysis.

function settings ​

cpp
inline const core::Settings & settings() const

Return: the settings for analysis.

Updated on 2026-01-09 at 21:59:11 +0000