simulation.hpp

Go to the documentation of this file.

/*
 * Copyright 2020 Robert Bosch GmbH
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
#pragma once
 
#include <functional>  // for function<>
#include <memory>      // for unique_ptr<>
 
#include <boost/filesystem/path.hpp>  // for path
 
#include <fable/enum.hpp>  // for ENUM_SERIALIZATION
#include <sol/state.hpp>   // for state
 
#include "simulation_context.hpp"
#include "stack.hpp"  // for Stack
 
namespace engine {
 
struct SimulationResult {
  cloe::Stack config;
 
  std::string uuid;
  SimulationSync sync;
  cloe::Duration elapsed;
  SimulationOutcome outcome;
  std::vector<std::string> errors;
  SimulationStatistics statistics;
  cloe::Json triggers;
  cloe::Json report;
  cloe::Json signals;  // dump of all signals in DataBroker right before the simulation started
  std::vector<std::string>
      signals_autocompletion;  // pseudo lua file used for vscode autocompletion
  std::optional<std::filesystem::path> output_dir;
 
 public:
  std::filesystem::path get_output_filepath(const std::filesystem::path& filename) const {
    std::filesystem::path filepath;
    if (filename.is_absolute()) {
      filepath = filename;
    } else if (output_dir) {
      filepath = *output_dir / filename;
    } else {
      throw cloe::ModelError{"cannot determine output path for '{}'", filename.native()};
    }
 
    return filepath;
  }
 
  void set_output_dir() {
    if (config.engine.output_path) {
      // For $registry to be of value, output_path (~= $id) here needs to be set.
      if (config.engine.output_path->is_absolute()) {
        // If it's absolute, then registry_path doesn't matter.
        output_dir = *config.engine.output_path;
      } else if (config.engine.registry_path) {
        // Now, since output_dir is relative, we need the registry path.
        // We don't care here whether the registry is relative or not.
        output_dir = *config.engine.registry_path / *config.engine.output_path;
      }
    }
  }
 
  friend void to_json(cloe::Json& j, const SimulationResult& r) {
    j = cloe::Json{
        {"elapsed", r.elapsed},
        {"errors", r.errors},
        {"outcome", r.outcome},
        {"report", r.report},
        {"simulation", r.sync},
        {"statistics", r.statistics},
        {"uuid", r.uuid},
    };
  }
};
 
class Simulation {
 public:
  Simulation(cloe::Stack&& config, sol::state&& lua, const std::string& uuid);
  ~Simulation() = default;
 
  cloe::Logger logger() const { return logger_; }
 
  SimulationResult run();
 
  size_t write_output(const SimulationResult&) const;
 
  bool write_output_file(const std::filesystem::path& filepath, const cloe::Json& j) const;
 
  bool is_writable(const std::filesystem::path& filepath) const;
 
  void set_report_progress(bool value) { report_progress_ = value; }
 
  void signal_abort();
 
 private:
  cloe::Stack config_;
  sol::state lua_;
  cloe::Logger logger_;
  std::string uuid_;
  std::function<void()> abort_fn_;
 
  // Options:
  bool report_progress_{false};
};
 
}  // namespace engine