SerialPortSettings.hpp

Go to the documentation of this file.

#ifndef IV_SRC_MODEL_COMMS_SERIALPORTSETTINGS_HPP_
#define IV_SRC_MODEL_COMMS_SERIALPORTSETTINGS_HPP_
 
#include "core/types.hpp"
#include "filehandlers/xmlFile.hpp"
 
#include <termios.h>
 
namespace iv::model::comms::serial
{
 
enum class eBaudRate : speed_t
{
    BR0 = B0,
    BR50 = B50,
    BR75 = B75,
    BR110 = B110,
    BR134 = B134,
    BR150 = B150,
    BR200 = B200,
    BR300 = B300,
    BR600 = B600,
    BR1200 = B1200,
    BR1800 = B1800,
    BR2400 = B2400,
    BR4800 = B4800,
    BR9600 = B9600,
    BR19200 = B19200,
    BR38400 = B38400,
    BR57600 = B57600,
    BR115200 = B115200,
    BR230400 = B230400,
#ifdef __linux__
    BR460800 = B460800,
    BR500000 = B500000,
    BR576000 = B576000,
    BR921600 = B921600,
    BR1000000 = B1000000,
    BR1152000 = B1152000,
    BR1500000 = B1500000,
#if __MAX_BAUD > B2000000
    BR2000000 = B2000000,
    BR2500000 = B2500000,
    BR3000000 = B3000000,
    BR3500000 = B3500000,
    BR4000000 = B4000000,
#endif
#endif
    First = BR0,
    Last = BR4000000
};
 
enum class eDataBits : tcflag_t
{
    DB5 = CS5,
    DB6 = CS6,
    DB7 = CS7,
    DB8 = CS8,
    First = DB5,
    Last = DB8
};
 
enum class eParity : tcflag_t
{
    None = 0,
    Odd = PARENB | PARODD,
    Even = PARENB,
    Mark = PARENB | PARODD | CMSPAR,
    Space = PARENB | CMSPAR,
    First = None,
    Last = Even
};
 
enum class eStopBits : tcflag_t
{
    SB1 = 1,
    SB2 = 2,
    First = SB1,
    Last = SB2
};
 
enum class eFlowControl : tcflag_t
{
    None = 0,
    Hardware = 1,
    Software = 2,
    First = None,
    Last = Software
};
 
struct PortSettings
{
    PortSettings();
    PortSettings(std::string portName, iv::model::comms::serial::eBaudRate baudRate,
                 iv::model::comms::serial::eDataBits dataBits, iv::model::comms::serial::eParity parity,
                 iv::model::comms::serial::eStopBits stopBits, iv::model::comms::serial::eFlowControl flowControl,
                 iv::types::pollTime pollTime);
    PortSettings(const PortSettings &other);
    PortSettings(PortSettings &&other) noexcept;
    ~PortSettings();
 
    PortSettings &operator=(const PortSettings &other);
    PortSettings &operator=(PortSettings &&other) noexcept;
 
    bool load(const iv::file::xml::node &node);
    bool save(iv::file::xml::node &node) const;
 
    std::string _portName;
    iv::model::comms::serial::eBaudRate _baudRate;
    iv::model::comms::serial::eDataBits _dataBits;
    iv::model::comms::serial::eParity _parity;
    iv::model::comms::serial::eStopBits _stopBits;
    iv::model::comms::serial::eFlowControl _flowControl;
    iv::types::pollTime _pollTime;
 
    struct Keys
    {
        static constexpr std::string_view serialPortName {"PortName"};
        static constexpr std::string_view serialBaudRate {"BaudRate"};
        static constexpr std::string_view serialDataBits {"DataBits"};
        static constexpr std::string_view serialParity {"Parity"};
        static constexpr std::string_view serialStopBits {"StopBits"};
        static constexpr std::string_view serialFlowControl {"FlowControl"};
        static constexpr std::string_view serialPollTime {"PollTime"};
    };
 
    struct DefaultValues
    {
        static constexpr std::string string {};
    };
};
 
}// namespace iv::model::comms::serial
 
#endif//IV_SRC_MODEL_COMMS_SERIALPORTSETTINGS_HPP_