SerialPortConnection.h

Go to the documentation of this file.

#pragma once
#include "DLLInfo.h"
#include <NDEVR/Connection.h>
class QSerialPort;
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief A structure containing information needed to establish a SerialPortConnection.
    **/
    struct SerialPortInfo
    {
        String port_name;
        uint04 baud_rate;
        uint04 data_bits;
        uint04 parity;
        uint04 stop_bits;
        uint04 flow_control;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief A ConnectionBackend that allows the software to interface with QSerialPort for communicating
        with SerialPort devices.
    **/
    class NDEVR_SERIAL_PORT_API SerialPortConnection : public ConnectionBackend
    {
    public:
        SerialPortConnection(ProgressInfo* log);
        ~SerialPortConnection();
        virtual uint04 peek(char* s, uint04 size) const override;
        virtual uint04 rx(char*, uint04 size = Constant<uint04>::Max) override;
        virtual void tx(const String& command) override;
        virtual bool open(const ConnectionInfo& request) override;
        virtual void close() override;
        virtual bool isOpen() const override;
        virtual uint04 bytesAvailable() const override;
        virtual TranslatedString lastError() const override;
        bool setSerialPort(QSerialPort* serial_port, ConnectionOpenType connection_type = ConnectionOpenType::e_read_write, ProgressInfo* log = nullptr);
        virtual bool waitForReadyRead(const TimeSpan& span) override;
        void handleSerialPortError(int error, ProgressInfo* log);
        static void ToString(const QSerialPort& value, String& string);
        static void FromString(const String& string, QSerialPort& value);
        static ConnectionInfo CreateInfo(const QSerialPortInfo& value);
        static ConnectionInfo CreateInfo(const QSerialPort& value);
        String threadID() const override;
    protected:
        QSerialPort* m_serial_port = nullptr;
        TranslatedString m_last_error;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief A ConnectionFactory that enables the creation of a SerialPortConnection for interfacing with
        a QSerialPort
    **/
    class NDEVR_SERIAL_PORT_API SerialPortConnectionFactory : public ConnectionFactory
    {
    public:
        virtual bool handlesType(const String& request) const override;
        virtual ConnectionBackend* createConnection(const ConnectionInfo& request) override;
        virtual Buffer<QSerialPortInfo, uint04, ObjectAllocator<false>> availablePortInfo();
        virtual Buffer<ConnectionInfo> availableConnections(const ConnectionSearchParamaters& params) override;
        virtual Buffer<ConnectionCategory> availableConnectionCatagories() override;
    };
}