include/MantleAPI/Execution/i_environment_engine.h

+/*******************************************************************************
+ * Copyright (c) 2024, Mercedes-Benz Tech Innovation GmbH
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *******************************************************************************/
+
+#ifndef MANTLEAPI_EXECUTION_I_ENVIRONMENT_ENGINE_H
+#define MANTLEAPI_EXECUTION_I_ENVIRONMENT_ENGINE_H
+
+#include <MantleAPI/Execution/i_environment.h>
+#include <MantleAPI/Execution/i_steppable.h>
+
+namespace mantle_api
+{
+
+/// Interface for classes that manage the environment
+struct IEnvironmentEngine : public ISteppable
+{
+  virtual ~IEnvironmentEngine() = default;
+
+  /// \brief Get the environment
+  virtual mantle_api::IEnvironment* GetEnvironment() noexcept = 0;
+};
+
+}  // namespace mantle_api
+
+#endif  // MANTLEAPI_EXECUTION_I_ENVIRONMENT_ENGINE_H

include/MantleAPI/Execution/i_scenario_engine.h

 /*******************************************************************************
  * Copyright (c) 2021-2023, Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
  * Copyright (c) 2022 Ansys, Inc.
+ * Copyright (c) 2024, Mercedes-Benz Tech Innovation GmbH
  *
  * This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0
@@ -16,15 +17,14 @@
 #ifndef MANTLEAPI_EXECUTION_I_SCENARIO_ENGINE_H
 #define MANTLEAPI_EXECUTION_I_SCENARIO_ENGINE_H
 
+#include <MantleAPI/Execution/i_steppable.h>
 #include <MantleAPI/Execution/scenario_info.h>
 
-#include <string>
-
 namespace mantle_api
 {
 
 /// Base interface for the scenario
-class IScenarioEngine
+class IScenarioEngine : public ISteppable
 {
 public:
   virtual ~IScenarioEngine() = default;
@@ -44,12 +44,6 @@ public:
   /// Can be called multiple times for consecutive simulation runs.
   virtual void SetupDynamicContent() = 0;
 
-  /// Calculate the new state of the scenario implementation.
-  ///
-  /// Calling this function after `IsFinished()` should be a no-op.
-  /// @see IsFinished()
-  virtual void Step() = 0;
-
   /// Indicates whether the scenario implementation has finished processing the scenario (end of scenario is reached).
   /// @return `true` if processing the scenario is complete, `false` otherwise.
   [[nodiscard]] virtual bool IsFinished() const = 0;

include/MantleAPI/Execution/i_steppable.h

+/*******************************************************************************
+ * Copyright (c) 2024, Mercedes-Benz Tech Innovation GmbH
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *******************************************************************************/
+
+#ifndef MANTLEAPI_EXECUTION_I_STEPPABLE_H
+#define MANTLEAPI_EXECUTION_I_STEPPABLE_H
+
+#include <MantleAPI/Common/time_utils.h>
+
+#include <optional>
+
+namespace mantle_api
+{
+
+/// Interface for classes that can be stepped in time
+struct ISteppable
+{
+  virtual ~ISteppable() = default;
+
+  /// \brief Calculate the new state
+  /// \param[in] size The time step size
+  virtual void Step(Time size) = 0;
+
+  /// \brief Get the time step size
+  /// \return The time step size
+  [[nodiscard]] virtual std::optional<mantle_api::Time> GetStepSize() const noexcept = 0;
+};
+
+}  // namespace mantle_api
+
+#endif  // MANTLEAPI_EXECUTION_I_STEPPABLE_H

test/MantleAPI/CMakeLists.txt

 ################################################################################
-# Copyright (c) 2023 Mercedes-Benz Tech Innovation GmbH
+# Copyright (c) 2023-2024, Mercedes-Benz Tech Innovation GmbH
 #
 # This program and the accompanying materials are made available under the terms
 # of the Eclipse Public License 2.0 which is available at
@@ -9,3 +9,4 @@
 ################################################################################
 
 add_subdirectory(Common)
+add_subdirectory(Execution)

test/MantleAPI/Execution/CMakeLists.txt

+################################################################################
+# Copyright (c) 2024, Mercedes-Benz Tech Innovation GmbH
+#
+# This program and the accompanying materials are made available under the terms
+# of the Eclipse Public License 2.0 which is available at
+# https://www.eclipse.org/legal/epl-2.0/
+#
+# SPDX-License-Identifier: EPL-2.0
+################################################################################
+
+add_executable(ExecutionTest)
+target_sources(ExecutionTest PUBLIC environment_engine_test.cc)
+target_include_directories(ExecutionTest PRIVATE $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/test>)
+target_link_libraries(ExecutionTest PUBLIC MantleAPI::MantleAPI GTest::gmock_main)
+
+include(GoogleTest)
+gtest_discover_tests(ExecutionTest)

test/MantleAPI/Execution/environment_engine_test.cc

+/*******************************************************************************
+ * Copyright (c) 2024, Mercedes-Benz Tech Innovation GmbH
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *******************************************************************************/
+
+#include <gmock/gmock.h>
+#include <gtest/gtest.h>
+
+#include "MantleAPI/Execution/i_environment_engine.h"
+#include "MantleAPI/Execution/mock_environment_engine.h"
+
+namespace
+{
+
+using testing::_;
+using testing::Const;
+
+class EnvironmentEngineTest : public testing::Test
+{
+protected:
+  mantle_api::MockEnvironmentEngine mock_environment_engine_;
+  mantle_api::IEnvironmentEngine &environment_engine_{mock_environment_engine_};
+};
+
+TEST_F(EnvironmentEngineTest, GetEnvironment)
+{
+  EXPECT_CALL(mock_environment_engine_, GetEnvironment()).Times(1);
+  ASSERT_FALSE(environment_engine_.GetEnvironment());
+}
+
+TEST_F(EnvironmentEngineTest, Step)
+{
+  EXPECT_CALL(mock_environment_engine_, Step(_)).Times(1);
+  ASSERT_NO_THROW(environment_engine_.Step({}));
+}
+
+TEST_F(EnvironmentEngineTest, GetStepSize)
+{
+  EXPECT_CALL(Const(mock_environment_engine_), GetStepSize()).Times(1);
+  ASSERT_FALSE(environment_engine_.GetStepSize());
+}
+
+}  // namespace

test/MantleAPI/Execution/mock_environment_engine.h

+/*******************************************************************************
+ * Copyright (c) 2024, Mercedes-Benz Tech Innovation GmbH
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *******************************************************************************/
+
+#ifndef MANTLEAPI_COMMON_MOCK_ENVIRONMENT_ENGINE_H
+#define MANTLEAPI_COMMON_MOCK_ENVIRONMENT_ENGINE_H
+
+#include <gmock/gmock.h>
+
+#include "MantleAPI/Execution/i_environment_engine.h"
+
+namespace mantle_api
+{
+
+class MockEnvironmentEngine final : public IEnvironmentEngine
+{
+public:
+  MOCK_METHOD(mantle_api::IEnvironment*, GetEnvironment, (), (noexcept, override));
+  MOCK_METHOD(void, Step, (Time size), (override));
+  MOCK_METHOD(std::optional<mantle_api::Time>, GetStepSize, (), (const, noexcept, override));
+};
+
+}  // namespace mantle_api
+
+#endif  // MANTLEAPI_COMMON_MOCK_ENVIRONMENT_ENGINE_H