ValveManager.hpp

Go to the documentation of this file.

#ifndef IV_SRC_MODEL_CONTROLS_VALVEMANAGER_HPP_
#define IV_SRC_MODEL_CONTROLS_VALVEMANAGER_HPP_
 
#include "core/types.hpp"
#include "filehandlers/xmlFile.hpp"
#include "model/control/Valve.hpp"
#include "model/control/enums.hpp"
 
#include <list>
#include <map>
#include <memory>
#include <optional>
#include <set>
 
namespace iv::model::control
{
 
class ValveManager
{
public:
    ValveManager() = default;
    ~ValveManager() = default;
 
    void update(const ValveManager &other);
    bool load(const iv::file::xml::node &nodeValves);
    bool save(iv::file::xml::node &nodeValves) const;
 
    bool insertValve(const std::shared_ptr<iv::model::control::Valve> &valve);
 
    bool createValve(valve::eValveSystem valveSystem, iv::types::control::valve::valveOrder valveOrder,
                     iv::model::control::valve::eValveType valveType, iv::types::unitId lomId,
                     const iv::model::control::valve::AllValveChannels &allValveChannels);
 
    bool changeValveSystemAndOrder(const iv::types::control::valve::valveId &oldValveId,
                                   iv::model::control::valve::eValveSystem newValveSystem,
                                   iv::types::control::valve::valveOrder newValveOrder);
 
    bool removeValve(const types::control::valve::valveId &valveId, bool resetWiredChannels,
                     bool removeSoftwareChannels);
 
    void getValveValidDefaultParameters(iv::model::control::valve::eValveSystem &defaultValveSystem,
                                        iv::types::control::valve::valveOrder &defaultValveOrder,
                                        valve::eValveType &defaultValveType, iv::types::unitId &defaultLomId);
 
    [[nodiscard]]
    static std::set<iv::types::unitId> getAvailableLomIds(iv::model::control::valve::eValveType valveType);
 
    [[nodiscard]]
    static std::optional<std::shared_ptr<iv::channels::AbstractChannel>>
    getTheNAvailableValveFeedbackChannel(iv::types::unitId lomId, uint16_t n);
 
    [[nodiscard]]
    static std::optional<std::shared_ptr<iv::channels::AbstractChannel>>
    getTheNAvailableValveOrderChannel(iv::types::unitId lomId, uint16_t n);
 
    [[nodiscard]]
    static iv::model::control::valve::eLomAvailability
    getLomAvailability(const std::shared_ptr<iv::units::Unit> &unit, iv::model::control::valve::eValveType valveType);
 
    [[nodiscard]] std::map<iv::types::control::valve::valveId, std::shared_ptr<iv::model::control::Valve>> &valves();
 
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 linkAndConfigureValveChannels(const std::shared_ptr<iv::model::control::Valve> &valve);
 
    static void reconfigureValveChannels(const std::shared_ptr<iv::model::control::Valve> &valve);
 
    static void resetValveWiredChannels(const std::shared_ptr<iv::model::control::Valve> &valve);
 
    static void removeValveSoftwareChannels(const std::shared_ptr<iv::model::control::Valve> &valve);
 
    static bool configureChFeedbackOP(const std::shared_ptr<iv::channels::AbstractChannel> &channel,
                                      iv::types::control::valve::valveId valveId);
    static bool configureChFeedbackCL(const std::shared_ptr<iv::channels::AbstractChannel> &channel,
                                      iv::types::control::valve::valveId valveId);
    static bool configureChOutputOP(const std::shared_ptr<iv::channels::AbstractChannel> &channel,
                                    iv::types::control::valve::valveId valveId);
    static bool configureChOutputCL(const std::shared_ptr<iv::channels::AbstractChannel> &channel,
                                    iv::types::control::valve::valveId valveId);
    static bool configureChCmdOP(const std::shared_ptr<iv::channels::AbstractChannel> &channel,
                                 const iv::types::control::valve::valveId &valveId,
                                 iv::types::channelOrder channelOrder, iv::types::unitId unitId,
                                 bool isConfiguringFromController);
    static bool configureChCmdCL(const std::shared_ptr<iv::channels::AbstractChannel> &channel,
                                 const iv::types::control::valve::valveId &valveId,
                                 iv::types::channelOrder channelOrder, iv::types::unitId unitId,
                                 bool isConfiguringFromController);
    static bool configureChCmdReset(const std::shared_ptr<iv::channels::AbstractChannel> &channel,
                                    const iv::types::control::valve::valveId &valveId,
                                    iv::types::channelOrder channelOrder, iv::types::unitId unitId,
                                    bool isConfiguringFromController);
    static bool configureChTrip(const std::shared_ptr<iv::channels::AbstractChannel> &channel,
                                const iv::types::control::valve::valveId &valveId, iv::types::channelOrder channelOrder,
                                iv::types::unitId unitId, bool isConfiguringFromController);
 
    std::map<iv::types::control::valve::valveId, std::shared_ptr<iv::model::control::Valve>> m_valves;
 
    struct Sections
    {
        static constexpr std::string_view valve {"Valve"};
    };
    struct Constants
    {
        static constexpr uint16_t maxValveOrderValue {999};
        static constexpr uint16_t numCmdChannels {3};
        static constexpr uint16_t numTripChannels {1};
        static constexpr std::pair<iv::types::channelOrder, iv::types::channelOrder> valveCmdChannelOrderRange {400,
                                                                                                                499};
        static constexpr std::pair<iv::types::channelOrder, iv::types::channelOrder> valveTripChannelOrderRange {300,
                                                                                                                 363};
    };
};
 
}// namespace iv::model::control
 
#endif//IV_SRC_MODEL_CONTROLS_VALVEMANAGER_HPP_