AbstractModbusCommunicationProtocol.hpp

Go to the documentation of this file.

#ifndef IV_SRC_COMMS_MODBUS_ABSTRACTMODBUSCOMMUNICATIONPROTOCOL_HPP_
#define IV_SRC_COMMS_MODBUS_ABSTRACTMODBUSCOMMUNICATIONPROTOCOL_HPP_
 
#include "comms/ICommunicationProtocol.hpp"
#include "comms/modbus/ModbusMessage.hpp"
 
namespace iv::comms::modbus
{
 
class AbstractModbusCommunicationProtocol : public iv::comms::ICommunicationProtocol
{
public:
    AbstractModbusCommunicationProtocol() = delete;
    AbstractModbusCommunicationProtocol(
            const std::shared_ptr<iv::comms::ICommunicationDriver> &driver, iv::model::comms::modbus::Settings settings,
            const std::weak_ptr<iv::diamar::AppFailuresLoggerManager> &appFailuresLoggerManager,
            iv::types::networkId networkId, std::weak_ptr<iv::channels::AbstractChannel> &heartbeatChannel);
    AbstractModbusCommunicationProtocol(const AbstractModbusCommunicationProtocol &other) = delete;
    AbstractModbusCommunicationProtocol(AbstractModbusCommunicationProtocol &&other) = delete;
    ~AbstractModbusCommunicationProtocol() override = default;
 
    AbstractModbusCommunicationProtocol &operator=(const AbstractModbusCommunicationProtocol &other) = delete;
    AbstractModbusCommunicationProtocol &operator=(AbstractModbusCommunicationProtocol &&other) = delete;
 
    [[nodiscard]] bool isOnline() override
    {
        return m_driver->isOnline();
    }
 
    virtual bool writeQueries() = 0;
    virtual bool readQueries() = 0;
 
    std::optional<iv::types::comms::modbus::registerValue>
    getAddressValue(const iv::types::comms::modbus::modbusAddressAndFunction &addressAndFunct);
 
    void emptyGrid();
 
protected:
    void buildAllQueries(const std::map<iv::types::comms::modbus::modbusAddressAndFunction,
                                        std::vector<std::shared_ptr<iv::channels::AbstractChannel>>> &channels,
                         const iv::types::networkId &netId, bool forceContinuousRegisters);
 
    iv::model::comms::modbus::Settings m_modbusSettings;
 
    std::vector<iv::comms::modbus::ModbusQueryMessage> m_queriesCoils; 
    std::vector<iv::comms::modbus::ModbusQueryMessage>
            m_queriesDiscreteInputs; 
    std::vector<iv::comms::modbus::ModbusQueryMessage>
            m_queriesInputRegisters; 
    std::vector<iv::comms::modbus::ModbusQueryMessage>
            m_queriesHoldingRegisters; 
    std::vector<iv::comms::modbus::ModbusQueryMessage>
            m_queriesWriteCoils; 
    std::vector<iv::comms::modbus::ModbusQueryMessage>
            m_queriesWriteRegisters; 
    std::map<iv::types::comms::modbus::modbusAddressAndFunction, std::optional<iv::types::comms::modbus::registerValue>>
            m_valueAtAddress; 
    std::weak_ptr<iv::channels::AbstractChannel> m_heartbeatChannel;
    std::weak_ptr<iv::diamar::AppFailuresLoggerManager> m_appFailuresLoggerManager;
    iv::types::networkId m_networkId;
 
private:
    static void
    classifyChannelsMap(const std::map<iv::types::comms::modbus::modbusAddressAndFunction,
                                       std::vector<std::shared_ptr<iv::channels::AbstractChannel>>> &channelsByAddress,
                        std::vector<std::shared_ptr<iv::channels::AbstractChannel>> &readCoils,
                        std::vector<std::shared_ptr<iv::channels::AbstractChannel>> &readDiscreteInputs,
                        std::vector<std::shared_ptr<iv::channels::AbstractChannel>> &readInputRegisters,
                        std::vector<std::shared_ptr<iv::channels::AbstractChannel>> &readHoldingRegisters,
                        std::vector<std::shared_ptr<iv::channels::AbstractChannel>> &writeCoils,
                        std::vector<std::shared_ptr<iv::channels::AbstractChannel>> &writeHoldingRegisters,
                        const iv::types::networkId &netId);
 
    [[nodiscard]] std::vector<iv::comms::modbus::ModbusQueryMessage>
    buildSpecificQuery(const std::vector<std::shared_ptr<iv::channels::AbstractChannel>> &chVectOrderedByAddress,
                       uint16_t maxRegPerQuery, iv::comms::modbus::eFunctionCode mbFunction,
                       const iv::types::networkId &netId, bool forceContinuousRegisters = false) const;
};
 
}// namespace iv::comms::modbus
 
#endif//IV_SRC_COMMS_MODBUS_ABSTRACTMODBUSCOMMUNICATIONPROTOCOL_HPP_