SerialPortConfig.h

Go to the documentation of this file.

// (c) IMT - Information Management Technology AG, CH-9470 Buchs, www.imt.ch.
 
#ifndef IMT_BASE_OS_LINUX_SERIALPORTCONFIG_H
#define IMT_BASE_OS_LINUX_SERIALPORTCONFIG_H
 
#include <Imt.Base.Core.Platform/Platform.h>
#include <string>
 
namespace imt {
namespace base {
namespace os {
namespace linux {
 
class SerialPortConfig final {
 
public:
 
    enum class BitRate : uint32_t {
        BPS_0 = 0,
        BPS_50 = 50,
        BPS_75 = 75,
        BPS_110 = 110,
        BPS_134 = 134,
        BPS_150 = 150,
        BPS_200 = 200,
        BPS_300 = 300,
        BPS_600 = 600,
        BPS_1200 = 1200,
        BPS_1800 = 1800,
        BPS_2400 = 2400,
        BPS_4800 = 4800,
        BPS_9600 = 9600,
        BPS_19200 = 19200,
        BPS_38400 = 38400,
        BPS_57600 = 57600,
        BPS_115200 = 115200,
        BPS_230400 = 230400,
        BPS_460800 = 460800,
        BPS_500000 = 500000,
        BPS_576000 = 576000,
        BPS_921600 = 921600,
        BPS_1000000 = 1000000,
        BPS_1152000 = 1152000,
        BPS_1500000 = 1500000,
        BPS_2000000 = 2000000,
        BPS_2500000 = 2500000,
        BPS_3000000 = 3000000,
        BPS_3500000 = 3500000,
        BPS_4000000 = 4000000
    };
 
    enum class NumDataBits : uint8_t {
        FIVE,
        SIX,
        SEVEN,
        EIGHT
    };
 
    enum class NumStopBits : uint8_t {
        ONE,
        TWO
    };
 
    enum class Parity : uint8_t {
        NONE,
        EVEN,
        ODD,
    };
 
    enum class HardwareFlowControl : uint8_t {
        OFF,
        ON
    };
 
    void setDeviceName(std::string const& deviceName);
 
    std::string const& getDeviceName() const noexcept;
 
    void setBitRate(BitRate rate) noexcept;
 
    BitRate getBitRate() const noexcept;
 
    void setNumDataBits(NumDataBits dataBits) noexcept;
 
    NumDataBits getNumDataBits() const noexcept;
 
    void setNumStopBits(NumStopBits stopBits) noexcept;
 
    NumStopBits getNumStopBits() const noexcept;
 
    void setParity(Parity portParity) noexcept;
 
    Parity getParity() const noexcept;
 
    void setHardwareFlowControl(HardwareFlowControl hwFlowCtrl) noexcept;
 
    HardwareFlowControl getHardwareFlowControl() const noexcept;
 
private:
 
    std::string m_deviceName {};
    BitRate m_bitRate {BitRate::BPS_115200};
    NumDataBits m_dataBits {NumDataBits::EIGHT};
    NumStopBits m_stopBits {NumStopBits::ONE};
    Parity m_par {Parity::NONE};
    HardwareFlowControl m_hwFlowCtrl {HardwareFlowControl::OFF};
};
 
} // namespace linux
} // namespace os
} // namespace base
} // namespace imt
 
#endif // IMT_BASE_OS_LINUX_SERIALPORTCONFIG_H