RTUServerConfig.hpp

#ifndef H_EXTENSIONS_CUTEHMI_MODBUS_3_INCLUDE_CUTEHMI_MODBUS_INTERNAL_RTUSERVERCONFIG_HPP
#define H_EXTENSIONS_CUTEHMI_MODBUS_3_INCLUDE_CUTEHMI_MODBUS_INTERNAL_RTUSERVERCONFIG_HPP
 
#include "Config.hpp"
 
#include <QObject>
#include <QString>
#include <QReadWriteLock>
#include <QtSerialPort>
 
namespace cutehmi {
namespace modbus {
namespace internal {
 
class CUTEHMI_MODBUS_PRIVATE RTUServerConfig:
    public Config
{
        Q_OBJECT
 
    public:
        typedef std::pair<int, int> AddressRange;
 
        static constexpr int MIN_SLAVE_ADDRESS = 1; // Can be 1 to 247 according to http://www.simplymodbus.ca/FAQ.htm
        static constexpr int MAX_SLAVE_ADDRESS = 247; // Can be 1 to 247 according to http://www.simplymodbus.ca/FAQ.htm
        static const char * INITIAL_PORT;
        static constexpr QSerialPort::Parity INITIAL_PARITY = QSerialPort::NoParity;
        static constexpr QSerialPort::BaudRate INITIAL_BAUD_RATE = QSerialPort::Baud19200;
        static constexpr QSerialPort::DataBits INITIAL_DATA_BITS = QSerialPort::Data8;
        static constexpr QSerialPort::StopBits INITIAL_STOP_BITS = QSerialPort::OneStop;
        static constexpr int INITIAL_SLAVE_ADDRESS = MIN_SLAVE_ADDRESS;
        static constexpr int INITIAL_COILS_ADDRESS_RANGE_MIN = 0;
        static constexpr int INITIAL_COILS_ADDRESS_RANGE_MAX = 65535;
        static constexpr int INITIAL_DISCRETE_INPUTS_ADDRESS_RANGE_MIN = 0;
        static constexpr int INITIAL_DISCRETE_INPUTS_ADDRESS_RANGE_MAX = 65535;
        static constexpr int INITIAL_HOLDING_REGISTERS_ADDRESS_RANGE_MIN = 0;
        static constexpr int INITIAL_HOLDING_REGISTERS_ADDRESS_RANGE_MAX = 65535;
        static constexpr int INITIAL_INPUT_REGISTERS_ADDRESS_RANGE_MIN = 0;
        static constexpr int INITIAL_INPUT_REGISTERS_ADDRESS_RANGE_MAX = 65535;
 
        explicit RTUServerConfig(QObject * parent = nullptr);
 
        QString port() const;
 
        void setPort(const QString & port);
 
        QSerialPort::Parity parity() const;
 
        void setParity(QSerialPort::Parity parity);
 
        QSerialPort::BaudRate baudRate() const;
 
        void setBaudRate(QSerialPort::BaudRate baudRate);
 
        QSerialPort::DataBits dataBits() const;
 
        void setDataBits(QSerialPort::DataBits dataBits);
 
        QSerialPort::StopBits stopBits() const;
 
        void setStopBits(QSerialPort::StopBits stopBits);
 
        int slaveAddress() const;
 
        void setSlaveAddress(int address);
 
        AddressRange coilsAddressRange() const;
 
        void setCoilsAddressRange(AddressRange addressRange);
 
        AddressRange inputRegistersAddressRange() const;
 
        void setInputRegistersAddressRange(AddressRange addressRange);
 
        AddressRange discreteInputsAddressRange() const;
 
        void setDiscreteInputsAddressRange(AddressRange addressRange);
 
        AddressRange holdingRegistersAddressRange() const;
 
        void setHoldingRegistersAddressRange(AddressRange addressRange);
 
    private:
        struct Members
        {
            QString port = INITIAL_PORT;
            QSerialPort::Parity parity = INITIAL_PARITY;
            QSerialPort::BaudRate baudRate = INITIAL_BAUD_RATE;
            QSerialPort::DataBits dataBits = INITIAL_DATA_BITS;
            QSerialPort::StopBits stopBits = INITIAL_STOP_BITS;
            int slaveAddress = INITIAL_SLAVE_ADDRESS;
            AddressRange coilsAddressRange = AddressRange(INITIAL_COILS_ADDRESS_RANGE_MIN, INITIAL_COILS_ADDRESS_RANGE_MAX);
            AddressRange discreteInputsAddressRange = AddressRange(INITIAL_DISCRETE_INPUTS_ADDRESS_RANGE_MIN, INITIAL_DISCRETE_INPUTS_ADDRESS_RANGE_MAX);
            AddressRange holdingRegistersAddressRange = AddressRange(INITIAL_HOLDING_REGISTERS_ADDRESS_RANGE_MIN, INITIAL_HOLDING_REGISTERS_ADDRESS_RANGE_MAX);
            AddressRange inputRegistersAddressRange = AddressRange(INITIAL_INPUT_REGISTERS_ADDRESS_RANGE_MIN, INITIAL_INPUT_REGISTERS_ADDRESS_RANGE_MAX);
            mutable QReadWriteLock lock;
        };
 
        MPtr<Members> m;
};
 
}
}
}
 
#endif
 
//(c)C: Copyright © 2021, 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.