Register16Controller.hpp

#ifndef H_EXTENSIONS_CUTEHMI_MODBUS_4_INCLUDE_CUTEHMI_MODBUS_REGISTER16CONTROLLER_HPP
#define H_EXTENSIONS_CUTEHMI_MODBUS_4_INCLUDE_CUTEHMI_MODBUS_REGISTER16CONTROLLER_HPP
 
#include "internal/common.hpp"
#include "internal/RegisterControllerMixin.hpp"
#include "Register16.hpp"
#include "AbstractRegisterController.hpp"
 
#include <QBasicTimer>
#include <QQmlEngine>
 
namespace cutehmi {
namespace modbus {
 
class CUTEHMI_MODBUS_API Register16Controller:
    public cutehmi::modbus::AbstractRegisterController,
    protected internal::RegisterControllerMixin<Register16Controller>
{
        Q_OBJECT
        QML_NAMED_ELEMENT(Register16Controller)
        QML_UNCREATABLE("Register16Controller is an abstract class")
 
        friend class internal::RegisterControllerMixin<Register16Controller>;
        typedef internal::RegisterControllerMixin<Register16Controller> Mixin;
 
    public:
        enum Encoding {
            INT16,
            UINT16
        };
        Q_ENUM(Encoding)
 
        static constexpr qreal INITIAL_VALUE = 0.0;
        static constexpr qreal INITIAL_VALUE_SCALE = 1.0;
        static constexpr Encoding INITIAL_ENCODING = UINT16;
 
        Q_PROPERTY(qreal value READ value WRITE setValue NOTIFY valueChanged)
        Q_PROPERTY(qreal valueScale READ valueScale WRITE setValueScale NOTIFY valueScaleChanged)
        Q_PROPERTY(Encoding encoding READ encoding WRITE setEncoding NOTIFY encodingChanged)
 
        Register16Controller(QObject * parent = nullptr);
 
        ~Register16Controller() override;
 
        qreal value() const;
 
        void setValue(qreal value);
 
        qreal valueScale() const;
 
        void setValueScale(qreal valueScale);
 
        Encoding encoding() const;
 
        void setEncoding(Encoding encoding);
 
    public slots:
        void writeValue();
 
    signals:
        void valueChanged();
 
        void valueUpdated();
 
        void valueScaleChanged();
 
        void encodingChanged();
 
        void valueWritten();
 
        void valueFailed();
 
        void valueMismatch();
 
    protected:
        virtual AbstractDevice::Function readRegistersFunction() const = 0;
 
        virtual AbstractDevice::Function writeRegisterFunction() const = 0;
 
        virtual void requestWriteRegister(quint16 address, quint16 value, QUuid * requestId) const = 0;
 
        virtual Register16 * registerAt(quint16 address) const = 0;
 
        void timerEvent(QTimerEvent * event) override;
 
        quint16 bytes() const override;
 
        void onDeviceDestroyed() override;
 
    protected slots:
        void onRequestCompleted(QJsonObject request, QJsonObject reply) override;
 
        void resetRegister();
 
    private:
        void updateValue();
 
        void updateValue(quint16 value);
 
        void updateValue(const QJsonValue & value);
 
        static qreal Decode(quint16 value, Encoding encoding);
 
        static quint16 Encode(qreal value, Encoding encoding);
 
        static bool ValidateEncoding(qreal value, Encoding encoding);
 
        void requestWrite(qreal value);
 
        bool verifyRegisterValue() const;
 
    private:
        struct Members
        {
            qreal value;
            qreal valueScale;
            Encoding encoding;
            bool postponedWritePending;
            bool adjustingValue;
            qreal requestedValue;
            Register16 * register16;
            QUuid requestId;
            QBasicTimer writeTimer;
 
            Members():
                value(INITIAL_VALUE),
                valueScale(INITIAL_VALUE_SCALE),
                encoding(INITIAL_ENCODING),
                postponedWritePending(false),
                adjustingValue(false),
                requestedValue(0.0),
                register16(nullptr)
            {
            }
        };
 
        MPtr<Members> m;
};
 
}
}
 
#endif
 
//(c)C: Copyright © 2022, Michał Policht <michal@policht.pl>. All rights reserved.
//(c)C: SPDX-License-Identifier: LGPL-3.0-or-later OR MIT
//(c)C: This file is a part of CuteHMI.
//(c)C: CuteHMI is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
//(c)C: CuteHMI is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
//(c)C: You should have received a copy of the GNU Lesser General Public License along with CuteHMI.  If not, see <https://www.gnu.org/licenses/>.
//(c)C: Additionally, this file is licensed under terms of MIT license as expressed below.
//(c)C: Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
//(c)C: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
//(c)C: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.