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 <filesystem>  // for path
#include <functional>  // for function<>
#include <optional>    // for optional<>
 
#include <cloe/stack.hpp>      // for Stack
#include <sol/state_view.hpp>  // for state_view
 
namespace engine {
 
class SimulationContext;
class SimulationMachine;
class SimulationResult;
class SimulationProbe;
 
class Simulation {
 public:
  Simulation(const Simulation&) = default;
  Simulation(Simulation&&) = delete;
  Simulation& operator=(const Simulation&) = default;
  Simulation& operator=(Simulation&&) = delete;
  Simulation(cloe::Stack&& config, sol::state_view lua, const std::string& uuid);
  ~Simulation() = default;
 
  cloe::Logger logger() const { return logger_; }
 
  SimulationResult run();
 
  SimulationProbe probe();
 
  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:
  void set_output_dir();
 
  std::filesystem::path get_output_filepath(const std::filesystem::path& filename) const;
 
  void set_abort_handler(SimulationMachine& machine, SimulationContext& ctx,
                         std::function<void()> hook);
 
  void reset_abort_handler() { abort_fn_ = nullptr; }
 
 private:
  cloe::Stack config_;
  sol::state_view lua_;
  cloe::Logger logger_;
  std::string uuid_;
  std::optional<std::filesystem::path> output_dir_;
  std::function<void()> abort_fn_;
 
  // Options:
  bool report_progress_{false};
};
 
}  // namespace engine