imstkSimulationManager.h

/*
** This file is part of the Interactive Medical Simulation Toolkit (iMSTK)
** iMSTK is distributed under the Apache License, Version 2.0.
** See accompanying NOTICE for details.
*/

#pragma once

#include "imstkModuleDriver.h"

#include <unordered_map>

namespace imstk
{
class Viewer;

class SimulationManager : public ModuleDriver
{
public:
    // Generally STL is better for less interruption
    enum class ThreadingType
    {
        TBB,
        STL
    };

    SimulationManager() = default;
    ~SimulationManager() override = default;

    // *INDENT-OFF*
    SIGNAL(SimulationManager, starting);

    SIGNAL(SimulationManager, ending);
    // *INDENT-ON*

    void start() override;

    void addModule(std::shared_ptr<Module> module) override;

    void clearModules() override;

    void setDesiredDt(const double dt)
    {
        m_desiredDt = dt;
    }

    double getDesiredDt() const
    {
        return m_desiredDt;
    }

    double getDt() const
    {
        return m_dt;
    }

    void setThreadType(ThreadingType threadType)
    {
        m_threadType = threadType;
    }

    void setUseRemainderTimeDivide(const bool useRemainderTimeDivide) { m_useRemainderTimeDivide = useRemainderTimeDivide; }
    bool getUseRemainderTimeDivide() const { return m_useRemainderTimeDivide; }

protected:
    void requestStop(Event* e);

    void runModuleParallel(std::shared_ptr<Module> module);

    std::vector<std::shared_ptr<Viewer>> m_viewers;

    std::unordered_map<Module*, bool> m_running;

    std::vector<std::shared_ptr<Module>> m_syncModules;      
    std::vector<std::shared_ptr<Module>> m_asyncModules;     
    std::vector<std::shared_ptr<Module>> m_adaptiveModules;  

    ThreadingType m_threadType = ThreadingType::STL;
    double m_desiredDt = 0.003;             
    double m_dt       = 0.0;                
    int    m_numSteps = 0;
    bool   m_useRemainderTimeDivide = true; 
};
};                                          // namespace imstk