PmsManager.hpp

Go to the documentation of this file.

#ifndef IV_SRC_MODEL_PMS_PMSMANAGER_HPP_
#define IV_SRC_MODEL_PMS_PMSMANAGER_HPP_
 
#include "core/types.hpp"
#include "filehandlers/xmlFile.hpp"
#include "mimics/enums.hpp"
#include "model/pms/BusTie.hpp"
#include "model/pms/Generator.hpp"
#include "model/pms/MainBar.hpp"
#include "model/pms/Mode.hpp"
 
#include <map>
#include <memory>
#include <set>
 
namespace iv::model::pms
{
 
class PmsManager
{
    struct RunningModeTransition
    {
        std::thread thread;
        bool isRunning;
        bool isRunningLocally {false};
        std::mutex mutex;
    };
 
public:
    PmsManager() = default;
    ~PmsManager() = default;
 
    void update(const PmsManager &other);
    bool load(std::string_view pathPms);
    bool save(std::string_view pathPms,
              const std::optional<std::shared_ptr<std::vector<std::shared_ptr<iv::file::xml::File>>>> &savingFilesOut =
                      std::nullopt) const;
 
    bool insertMainBar(const std::shared_ptr<MainBar> &mainBar);
    bool insertBusTie(const std::shared_ptr<BusTie> &busTie);
    bool insertGenerator(const std::shared_ptr<Generator> &generator);
    bool insertMode(const std::shared_ptr<Mode> &mode);
    bool insertTransition(const std::shared_ptr<Transition> &transition);
    bool insertAction(const iv::types::pms::modeId &sourceModeId, const iv::types::pms::modeId &modeToReachId,
                      const std::shared_ptr<AbstractPmsAction> &action);
 
    std::optional<iv::types::pms::elementId> createMainBar(const std::string &name);
    std::optional<iv::types::pms::elementId> createBusTie(const std::string &name, iv::types::unitId lomId,
                                                          iv::types::pms::elementId leftMainBarId,
                                                          iv::types::pms::elementId rightMainBarId);
    std::optional<iv::types::pms::elementId> createGenerator(const std::string &name, iv::types::unitId lomId,
                                                             iv::model::pms::eGeneratorType type,
                                                             iv::types::pms::elementId mainBarId, uint32_t ratedPower);
    std::optional<iv::types::pms::modeId> createMode(const std::string &modeId,
                                                     iv::types::milliseconds feedbackTimeout);
    bool createTransition(const iv::model::pms::Transition &newTransition);
    bool createAction(const iv::types::pms::modeId &sourceModeId, const iv::types::pms::modeId &modeToReachId,
                      const std::shared_ptr<iv::model::pms::AbstractPmsAction> &newAction);
 
    bool changeMainBarId(iv::types::pms::elementId oldMainBarId, iv::types::pms::elementId newMainBarId);
    bool changeBusTieId(iv::types::pms::elementId oldBusTieId, iv::types::pms::elementId newBusTieId);
    bool changeGeneratorId(iv::types::pms::elementId oldGeneratorId, iv::types::pms::elementId newGeneratorId);
    bool changeModeId(const iv::types::pms::modeId &oldModeId, const iv::types::pms::modeId &newModeId);
    bool changeTransitionModeToReachId(const iv::types::pms::modeId &sourceModeId,
                                       const iv::types::pms::modeId &oldModeToReachId,
                                       const iv::types::pms::modeId &newModeToReachId);
 
    bool replaceAction(const iv::types::pms::modeId &sourceModeId, const iv::types::pms::modeId &modeToReachId,
                       uint64_t actionIndex, const std::shared_ptr<iv::model::pms::AbstractPmsAction> &newAction);
 
    bool updateBusTieLeftMainBar(iv::types::pms::elementId busTieId, iv::types::pms::elementId newLeftMainBarId);
    bool updateBusTieRightMainBar(iv::types::pms::elementId busTieId, iv::types::pms::elementId newRightMainBarId);
    bool updateGeneratorMainBar(iv::types::pms::elementId generatorId, iv::types::pms::elementId newMainBarId);
    bool updateGeneratorLomId(iv::types::pms::elementId generatorId, iv::types::unitId newLomId);
 
    bool eraseMainBar(iv::types::pms::elementId mainBarId);
    bool eraseBusTie(iv::types::pms::elementId busTieId);
    bool eraseGenerator(iv::types::pms::elementId generatorId);
    bool eraseMode(const iv::types::pms::modeId &modeId);
    bool eraseTransition(const iv::types::pms::modeId &sourceModeId, const iv::types::pms::modeId &modeToReachId);
    bool eraseAction(const iv::types::pms::modeId &sourceModeId, const iv::types::pms::modeId &modeToReachId,
                     uint64_t actionIndex);
 
    const std::map<iv::types::pms::elementId, std::shared_ptr<iv::model::pms::MainBar>> &mainBars();
    const std::map<iv::types::pms::elementId, std::shared_ptr<iv::model::pms::BusTie>> &busTies();
    const std::map<iv::types::pms::elementId, std::shared_ptr<iv::model::pms::Generator>> &generators();
    const std::map<iv::types::pms::modeId, std::shared_ptr<iv::model::pms::Mode>> &modes();
 
    [[nodiscard]] std::set<iv::types::pms::elementId> getBarsIds() const;
 
    bool moveUpAction(const iv::types::pms::modeId &sourceModeId, const iv::types::pms::modeId &modeToReachId,
                      uint64_t actionIndex);
    bool moveDownAction(const iv::types::pms::modeId &sourceModeId, const iv::types::pms::modeId &modeToReachId,
                        uint64_t actionIndex);
 
    void manageErasedUnit(const iv::types::unitId &unitId);
 
    [[nodiscard]] std::weak_ptr<iv::model::pms::Mode> getActivePmsMode() const;
 
    void setAndSendChannelTransitionFailureToAlarmValue() const;
    void setAndSendChannelTransitionFailureToNormalValue() const;
 
    static void setOperationModesMimicElementsState(const iv::types::pms::modeId &modeToReachId,
                                             const iv::mimics::elements::eOperationModeState &newModeState) ;
 
    void sendModeTransitionInfo(bool isRunning, const iv::types::pms::modeId &modeToReachId,
                                       const iv::mimics::elements::eOperationModeState &newModeState);
 
    RunningModeTransition m_runningModeTransition;
    std::weak_ptr<iv::channels::AbstractChannel> m_channelTransitionFailureAlarm;
 
private:
    static void unlinkGeneratorChannels(const std::shared_ptr<iv::model::pms::Generator> &generator);
    static bool channelsPmsToGenerator(const std::shared_ptr<iv::model::pms::Generator> &generator);
 
    std::map<iv::types::pms::elementId, std::shared_ptr<iv::model::pms::MainBar>> m_mainBars;
    std::map<iv::types::pms::elementId, std::shared_ptr<iv::model::pms::BusTie>> m_busTies;
    std::map<iv::types::pms::elementId, std::shared_ptr<iv::model::pms::Generator>> m_generators;
    std::map<iv::types::pms::modeId, std::shared_ptr<iv::model::pms::Mode>> m_modes;
 
    struct Sections
    {
        static constexpr std::string_view mainBars {"MainBars"};
        static constexpr std::string_view busTies {"BusTies"};
        static constexpr std::string_view generators {"Generators"};
        static constexpr std::string_view mainBar {"MainBar"};
        static constexpr std::string_view busTie {"BusTie"};
        static constexpr std::string_view generator {"Generator"};
        static constexpr std::string_view modes {"Modes"};
        static constexpr std::string_view mode {"Mode"};
    };
    struct Keys
    {
        static constexpr std::string_view failureChannel {"FailureChannel"};
    };
    struct DefaultValues
    {
        static constexpr std::string channel {};
    };
};
 
}// namespace iv::model::pms
 
#endif//IV_SRC_MODEL_PMS_PMSMANAGER_HPP_