SerialConnectionDialog.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
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.
 
Library: NDEVR
File: SerialConnectionDialog
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "NDEVRSerialPort/Headers/DLLInfo.h"
#include "HardwareWidgets/Headers/ConnectionDialog.h"
#include "Base/Headers/String.h"
#include <QSerialPort>
#include <QWidget>
namespace Ui 
{
    class SerialSetupUI;
}
 
class QIntValidator;
 
namespace NDEVR
{
    class Connection;
    /**--------------------------------------------------------------------------------------------------
    \brief A ConnectionDialog that allows the user to modify a Serial port connection.
    **/
    class NDEVR_SERIAL_PORT_API SerialConnectionDialog : public ConnectionDialog
    {
        Q_OBJECT
    public:
        struct Settings 
        {
            QString name;
            qint32 baudRate;
            QString stringBaudRate;
            QSerialPort::DataBits dataBits;
            QString stringDataBits;
            QSerialPort::Parity parity;
            QString stringParity;
            QSerialPort::StopBits stopBits;
            QString stringStopBits;
            QSerialPort::FlowControl flowControl;
            QString stringFlowControl;
        };
 
        explicit SerialConnectionDialog(QWidget *parent = nullptr);
        ~SerialConnectionDialog();
 
        Settings settings() const;
        QSerialPort* createSerialPort() const;
 
        virtual void clear()  override;
        virtual ConnectionInfo connectionInfo() const override;
        virtual void setConnectionInfo(const ConnectionInfo& connection)  override;
        virtual bool handlesConnection(const ConnectionInfo& connection)  override;
    //private slots:
        void showPortInfo(int idx);
        void apply();
        void cancel();
        void checkCustomBaudRatePolicy(int idx);
        void checkCustomDevicePathPolicy(int idx);
 
    private:
        void fillPortsParameters();
        void fillPortsInfo();
        void updateSettings();
 
    private:
        Ui::SerialSetupUI *ui = nullptr;
        Settings m_current_settings;
        QIntValidator *m_intValidator = nullptr;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief A ConnectionDialogFactory which enables the creation of a SerialConnectionDialog
    **/
    class SerialPortConnectionDialogFactory : public ConnectionDialogFactory
    {
    public:
        virtual bool handlesType(const String& connection) const override;
        virtual TranslatedString title() const override;
        virtual String icon() const override;
        virtual ConnectionDialog* createConnectionDialog() const override;
    };
}