DamperManager.hpp

Go to the documentation of this file.

#ifndef IV_SRC_MODEL_CONTROL_DAMPERMANAGER_HPP_
#define IV_SRC_MODEL_CONTROL_DAMPERMANAGER_HPP_
 
#include "core/types.hpp"
#include "filehandlers/xmlFile.hpp"
#include "model/control/Damper.hpp"
#include "model/control/enums.hpp"
 
#include <list>
#include <map>
#include <memory>
#include <optional>
#include <set>
 
namespace iv::model::control
{
 
class DamperManager
{
public:
    DamperManager() = default;
    ~DamperManager() = default;
 
    void update(const DamperManager &other);
    bool load(const iv::file::xml::node &nodeDampers);
    bool save(iv::file::xml::node &nodeDampers) const;
 
    bool insertDamper(const std::shared_ptr<iv::model::control::Damper> &damper);
 
    bool createDamper(const iv::types::control::damper::damperDescription &damperDescription,
                      iv::types::control::damper::damperOrder damperOrder,
                      iv::model::control::damper::eDamperType damperType, iv::types::unitId lomId,
                      const iv::model::control::damper::AllDamperChannels &allDamperChannels);
 
    bool changeDamperDescriptionAndOrder(const iv::types::control::damper::damperId &oldDamperId,
                                         const iv::types::control::damper::damperDescription &newDamperDescription,
                                         iv::types::control::damper::damperOrder newDamperOrder);
 
    bool removeDamper(const types::control::damper::damperId &damperId, bool resetWiredChannels,
                      bool removeSoftwareChannels);
 
    void getDamperValidDefaultParameters(iv::types::control::damper::damperOrder &defaultDamperOrder,
                                         damper::eDamperType &defaultDamperType, iv::types::unitId &defaultLomId);
 
    [[nodiscard]]
    static std::set<iv::types::unitId> getAvailableLomIds(iv::model::control::damper::eDamperType damperType);
 
    [[nodiscard]]
    static std::optional<std::shared_ptr<iv::channels::AbstractChannel>>
    getTheNAvailableDamperFeedbackChannel(iv::types::unitId lomId, uint16_t n);
 
    [[nodiscard]]
    static std::optional<std::shared_ptr<iv::channels::AbstractChannel>>
    getTheNAvailableDamperOrderChannel(iv::types::unitId lomId, uint16_t n);
 
    [[nodiscard]]
    static iv::model::control::damper::eLomAvailability
    getLomAvailability(const std::shared_ptr<iv::units::Unit> &unit,
                       iv::model::control::damper::eDamperType damperType);
 
    [[nodiscard]] std::map<iv::types::control::damper::damperId, std::shared_ptr<iv::model::control::Damper>> &
    dampers();
 
private:
    [[nodiscard]]
    static bool isDefaultChannel(const std::shared_ptr<iv::channels::AbstractChannel> &channel);
 
    [[nodiscard]]
    static uint16_t getNumAvailableDigitalOutputChannels(const std::shared_ptr<iv::units::Unit> &unit);
 
    static std::list<iv::types::channelOrder>
    getNumAvailableCmdChannelOrders(const std::shared_ptr<iv::units::Unit> &unit);
 
    static std::list<iv::types::channelOrder>
    getNumAvailableTripChannelOrders(const std::shared_ptr<iv::units::Unit> &unit);
 
    [[nodiscard]]
    static bool linkAndConfigureDamperChannels(const std::shared_ptr<iv::model::control::Damper> &damper);
 
    static void reconfigureDamperChannels(const std::shared_ptr<iv::model::control::Damper> &damper);
 
    static void resetDamperWiredChannels(const std::shared_ptr<iv::model::control::Damper> &damper);
 
    static void removeDamperSoftwareChannels(const std::shared_ptr<iv::model::control::Damper> &damper);
 
    static bool configureChFeedbackOP(const std::shared_ptr<iv::channels::AbstractChannel> &channel,
                                      iv::types::control::damper::damperId damperId,
                                      iv::types::control::damper::damperDescription damperDescription,
                                      iv::types::control::damper::damperOrder damperOrder);
    static bool configureChFeedbackCL(const std::shared_ptr<iv::channels::AbstractChannel> &channel,
                                      iv::types::control::damper::damperId damperId,
                                      iv::types::control::damper::damperDescription damperDescription,
                                      iv::types::control::damper::damperOrder damperOrder);
    static bool configureChOutputOP(const std::shared_ptr<iv::channels::AbstractChannel> &channel,
                                    iv::types::control::damper::damperId damperId,
                                    iv::types::control::damper::damperDescription damperDescription,
                                    iv::types::control::damper::damperOrder damperOrder);
    static bool configureChOutputCL(const std::shared_ptr<iv::channels::AbstractChannel> &channel,
                                    iv::types::control::damper::damperId damperId,
                                    iv::types::control::damper::damperDescription damperDescription,
                                    iv::types::control::damper::damperOrder damperOrder);
    static bool configureChCmdOP(const std::shared_ptr<iv::channels::AbstractChannel> &channel,
                                 const iv::types::control::damper::damperId &damperId,
                                 iv::types::channelOrder channelOrder, iv::types::unitId unitId,
                                 bool isConfiguringFromController,
                                 iv::types::control::damper::damperDescription damperDescription,
                                 iv::types::control::damper::damperOrder damperOrder);
    static bool configureChCmdCL(const std::shared_ptr<iv::channels::AbstractChannel> &channel,
                                 const iv::types::control::damper::damperId &damperId,
                                 iv::types::channelOrder channelOrder, iv::types::unitId unitId,
                                 bool isConfiguringFromController,
                                 iv::types::control::damper::damperDescription damperDescription,
                                 iv::types::control::damper::damperOrder damperOrder);
    static bool configureChCmdReset(const std::shared_ptr<iv::channels::AbstractChannel> &channel,
                                    const iv::types::control::damper::damperId &damperId,
                                    iv::types::channelOrder channelOrder, iv::types::unitId unitId,
                                    bool isConfiguringFromController,
                                    iv::types::control::damper::damperDescription damperDescription,
                                    iv::types::control::damper::damperOrder damperOrder);
    static bool configureChTrip(const std::shared_ptr<iv::channels::AbstractChannel> &channel,
                                const iv::types::control::damper::damperId &damperId,
                                iv::types::channelOrder channelOrder, iv::types::unitId unitId,
                                bool isConfiguringFromController,
                                iv::types::control::damper::damperDescription damperDescription,
                                iv::types::control::damper::damperOrder damperOrder);
 
    std::map<iv::types::control::damper::damperId, std::shared_ptr<iv::model::control::Damper>> m_dampers;
 
    struct Sections
    {
        static constexpr std::string_view damper {"Damper"};
    };
    struct Constants
    {
        static constexpr uint16_t maxDamperOrderValue {999};
        static constexpr uint16_t numCmdChannels {3};
        static constexpr uint16_t numTripChannels {1};
        static constexpr std::pair<iv::types::channelOrder, iv::types::channelOrder> damperCmdChannelOrderRange {400,
                                                                                                                 499};
        static constexpr std::pair<iv::types::channelOrder, iv::types::channelOrder> damperTripChannelOrderRange {300,
                                                                                                                  363};
    };
};
 
}// namespace iv::model::control
 
#endif//IV_SRC_MODEL_CONTROL_DAMPERMANAGER_HPP_