interface.h

#ifndef SERIAL_PORT_INTERFACE_H
#define SERIAL_PORT_INTERFACE_H
 
#include <string>
 
#include "serial_port/types.h"
 
namespace serial_port
{
 
    class Interface
    {
        // **************************************************************************
        // **************************************************************************
 
    public:
        // Constructors
        Interface() = default;
        explicit Interface(const Settings& settings);
        Interface(const std::string& port_name, int baud_rate,
            Parity parity = Parity::kNone,
            NumStopBits stop_bits = serial_port::NumStopBits::kOne,
            bool hardware_flow_control = false,
            unsigned long int timeout_s = 0, unsigned long int timeout_ms = 0);
        // Allow moving a serial port
        Interface(Interface&&) = default;
        Interface& operator=(Interface&& other) = default;
        // Do not allow copying a serial port
        Interface(const Interface&) = delete;
        Interface& operator=(const Interface& other) = delete;
 
        // Destructor. Cannot call pure virtual methods in destructor so derived classes
        // must call their respective Close() method in destructor themselves!
        virtual ~Interface() = 0;
        
 
        virtual void Open() = 0;
        virtual void Close() = 0;
        virtual bool IsOpen() = 0;
        [[nodiscard]] const Settings& GetSettings() const;
 
        virtual unsigned long NumBytesAvailable() = 0;
        virtual void FlushBuffer() const = 0;
 
        virtual unsigned long ReadData(char* data, unsigned long num_bytes) = 0;
        virtual std::string ReadString();
 
        virtual unsigned long WriteData(const char* data, unsigned long num_bytes) = 0;
        virtual unsigned long WriteString(const std::string& str);
 
        // **************************************************************************
        // **************************************************************************
 
    protected:
        Settings settings_;
    };
 
}
 
#endif // !SERIAL_PORT_INTERFACE_H