simulation_manager.h

Go to the documentation of this file.

/* * NRP Core - Backend infrastructure to synchronize simulations
 *
 * Copyright 2020-2023 NRP Team
 *
 * 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.
 *
 * This project has received funding from the European Union’s Horizon 2020
 * Framework Programme for Research and Innovation under the Specific Grant
 * Agreement No. 945539 (Human Brain Project SGA3).
 */
 
#ifndef SIMULATION_MANAGER_H
#define SIMULATION_MANAGER_H
 
#include "nrp_general_library/utils/json_schema_utils.h"
#include "nrp_general_library/utils/ptr_templates.h"
#include "nrp_general_library/engine_interfaces/engine_client_interface.h"
#include "nrp_simulation/datapack_handle/simulation_data_manager.h"
 
#include <mutex>
#include <functional>
 
class SimulationManager
        : public PtrTemplates<SimulationManager>
{
public:
 
    enum class SimState { Created, Initialized, Running, Stopped, Failed, NotSet};
 
    struct RequestResult
    {
        SimState currentState = SimState::NotSet;
        std::string errorMessage = "";
    };
 
    static void validateConfig(jsonSharedPtr &config);
 
    SimulationManager(const jsonSharedPtr &simulationConfig);
 
    SimulationManager() = delete;
 
    virtual ~SimulationManager() = default;
 
    RequestResult initializeSimulation();
 
    RequestResult resetSimulation();
 
    RequestResult stopSimulation();
 
    RequestResult runSimulationUntilDoneOrTimeout();
 
    virtual bool hasSimulationTimedOut() const = 0;
 
    RequestResult runSimulation(unsigned numIterations);
 
    RequestResult shutdownSimulation();
 
    SimState currentState();
 
    std::string printSimState(const SimState& simState);
 
    SimulationDataManager & getSimulationDataManager();
 
protected:
 
    // Callback functions for the different simulation control requests.
    virtual void initializeCB() = 0;
    virtual bool resetCB() = 0;
    virtual void stopCB() = 0;
    virtual bool runUntilDoneOrTimeoutCB() = 0;
    virtual bool runCB(unsigned numIterations) = 0;
    virtual void shutdownCB() = 0;
 
    jsonSharedPtr _simConfig;
 
    SimulationDataManager _simulationDataManager;
 
    SimulationTime _simTimeout = SimulationTime::zero();
 
private:
 
    SimState _simState;
 
    std::mutex _reqMutex;
 
    RequestResult processRequest(std::function<void ()> action, std::vector<SimState> validSourceStates,
                            std::string actionMsg1, std::string actionMsg2, bool lockMutex = true);
 
    void checkTransitionConstraints(std::vector<SimState> validSourceStates, std::string actionStr);
    void changeState(SimState newState);
};
 
 
#endif