fti_loop.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 FTI_LOOP_H
#define FTI_LOOP_H
 
#include "nrp_general_library/engine_interfaces/engine_client_interface.h"
 
#include "nrp_general_library/utils/json_schema_utils.h"
 
#include "nrp_simulation/datapack_handle/datapack_handle.h"
 
class FTILoop
        : public PtrTemplates<FTILoop>
{
    public:
 
        FTILoop() = default;
        FTILoop(jsonSharedPtr config, DataPackProcessor::engine_interfaces_t engines, SimulationDataManager * simulationDataManager);
 
        void initLoop();
 
        void resetLoop();
 
        void shutdownLoop();
 
        void waitForEngines();
 
        void runLoop(SimulationTime runLoopTime);
 
        inline SimulationTime getSimTime() const
        {   return this->_simTime;  }
 
    private:
        jsonSharedPtr _config;
 
        DataPackProcessor::engine_interfaces_t _engines;
 
        using engine_queue_t = std::multimap<SimulationTime, EngineClientInterfaceSharedPtr>;
 
        engine_queue_t _engineQueue;
 
        SimulationTime _simTime = SimulationTime::zero();
 
        unsigned long _simIteration = 0;
 
        std::unique_ptr<DataPackProcessor> _devHandler;
 
 
        friend class FTILoopTest_InitTFManager_Test;
};
 
using FTILoopSharedPtr = FTILoop::shared_ptr;
using FTILoopConstSharedPtr = FTILoop::const_shared_ptr;
 
#endif // FTI_LOOP_H