imstkModule.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 "imstkTimer.h"
#include "imstkEventObject.h"

namespace imstk
{
class Module : public EventObject
{
public:
    enum class ExecutionType
    {
        SEQUENTIAL,      // Should run in sync with other sequential modules
        PARALLEL,        // Should run in parallel
        ADAPTIVE         // Runs governed by module
    };

    Module() = default;
    ~Module() override = default;

    virtual const std::string getTypeName() const = 0;

    // *INDENT-OFF*
    SIGNAL(Module, preUpdate);

    SIGNAL(Module, postUpdate);

    SIGNAL(Module, end);
    // *INDENT-ON*

    double getDt() const { return m_dt; }
    void setDt(const double dt) { m_dt = dt; }

    bool getInit() const { return m_init; }

    bool getPaused() const { return m_paused; }
    void setPaused(const bool paused) { m_paused = paused; }

    void setMuteUpdateEvents(const bool mute) { m_muteUpdateEvents = mute; }
    bool getMuteUpdateEvents() const { return m_muteUpdateEvents; }

    ExecutionType getExecutionType() const { return m_executionType; }
    void setExecutionType(const ExecutionType type) { m_executionType = type; }

    void setSleepDelay(const double ms);
    double getSleepDelay() const { return m_sleepDelay; }

    void pause() { m_paused = true; }
    void resume() { m_paused = false; }

    void init() { m_init = initModule(); }

    void update();

    void uninit();

    virtual bool initModule() = 0;

    virtual void updateModule() = 0;

    virtual void uninitModule() { }

protected:
    std::atomic<bool> m_init   = ATOMIC_VAR_INIT(false);
    std::atomic<bool> m_paused = ATOMIC_VAR_INIT(false);
    double m_dt = 0.0;
    ExecutionType m_executionType = ExecutionType::PARALLEL; // Defaults to parallel, subclass and set
    bool   m_muteUpdateEvents     = false;                   // Avoid posting pre/post update, useful when running modules at extremely fast rates
    double m_sleepDelay = 0.0;                               // ms sleep for the module, useful for throttling some modules
};
} // namespace imstk