packages/engine/scram-node/src/analysis.h

Common facilities for all analysis classes.

Namespaces

Name
scram
scram::core

Classes

	Name
class	scram::core::Analysis <br>Base abstract class for all analysis with settings.

Source code

/*
 * Copyright (C) 2014-2018 Olzhas Rakhimov
 * Copyright (C) 2023 OpenPRA ORG Inc.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */


#pragma once

#include <cassert>

#include <string>

#include <boost/noncopyable.hpp>

#include "settings.h"

namespace scram::core {

class Analysis : private boost::noncopyable {
 public:
  explicit Analysis(Settings settings);

  virtual ~Analysis() = 0;  

  const Settings& settings() const { return settings_; }

  const std::string& warnings() const { return warnings_; }

  double analysis_time() const { return analysis_time_; }

    void AddAnalysisTime(double time) {
      assert(time >= 0 && "Cannot subtract time.");
      analysis_time_ += time;
    }

void AddWarning(std::string msg) {
  assert(!msg.empty() && "Warnings cannot be empty.");
  warnings_ += (warnings_.empty() ? "" : "; ") + msg;
}

Settings& settings() { return settings_; }

private:
  Settings settings_;  
  double analysis_time_;  
  std::string warnings_;  
};

}  // namespace scram::core

---

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