ground/openpilotgcs/src/plugins/gpsdisplay/gpsdisplaygadgetconfiguration.h

   1 /**
   2  ******************************************************************************
   3  *
   4  * @file       gpsdisplaygadgetconfiguration.h
   5  * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2010.
   6  * @addtogroup GCSPlugins GCS Plugins
   7  * @{
   8  * @addtogroup GPSGadgetPlugin GPS Gadget Plugin
   9  * @{
  10  * @brief A gadget that displays GPS status and enables basic configuration
  11  *****************************************************************************/
  12 /*
  13  * This program is free software; you can redistribute it and/or modify
  14  * it under the terms of the GNU General Public License as published by
  15  * the Free Software Foundation; either version 3 of the License, or
  16  * (at your option) any later version.
  17  *
  18  * This program is distributed in the hope that it will be useful, but
  19  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  20  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
  21  * for more details.
  22  *
  23  * You should have received a copy of the GNU General Public License along
  24  * with this program; if not, write to the Free Software Foundation, Inc.,
  25  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  26  */
  27
  28 #ifndef GPSDISPLAYGADGETCONFIGURATION_H
  29 #define GPSDISPLAYGADGETCONFIGURATION_H
  30
  31 #include <coreplugin/iuavgadgetconfiguration.h>
  32 #include <QtSerialPort/QSerialPort>
  33 #include <QtSerialPort/QSerialPortInfo>
  34
  35 using namespace Core;
  36
  37 /**
  38  * structure to contain port settings
  39  */
  40 struct PortSettings {
  41     QSerialPort::BaudRate    BaudRate;
  42     QSerialPort::DataBits    DataBits;
  43     QSerialPort::Parity      Parity;
  44     QSerialPort::StopBits    StopBits;
  45     QSerialPort::FlowControl FlowControl;
  46     long Timeout_Millisec;
  47 };
  48
  49 class GpsDisplayGadgetConfiguration : public IUAVGadgetConfiguration {
  50     Q_OBJECT
  51 public:
  52     explicit GpsDisplayGadgetConfiguration(QString classId, QSettings *qSettings = 0, QObject *parent = 0);
  53
  54     void setConnectionMode(QString mode)
  55     {
  56         m_connectionMode = mode;
  57     }
  58     QString connectionMode()
  59     {
  60         return m_connectionMode;
  61     }
  62
  63     // set port configuration functions
  64     void setSpeed(QSerialPort::BaudRate speed)
  65     {
  66         m_defaultSpeed = speed;
  67     }
  68     void setDataBits(QSerialPort::DataBits databits)
  69     {
  70         m_defaultDataBits = databits;
  71     }
  72     void setFlow(QSerialPort::FlowControl flow)
  73     {
  74         m_defaultFlow = flow;
  75     }
  76     void setParity(QSerialPort::Parity parity)
  77     {
  78         m_defaultParity = parity;
  79     }
  80     void setStopBits(QSerialPort::StopBits stopbits)
  81     {
  82         m_defaultStopBits = stopbits;
  83     }
  84     void setPort(QString port)
  85     {
  86         m_defaultPort = port;
  87     }
  88     void setTimeOut(long timeout)
  89     {
  90         m_defaultTimeOut = timeout;
  91     }
  92
  93     // get port configuration functions
  94     QString port()
  95     {
  96         return m_defaultPort;
  97     }
  98     QSerialPort::BaudRate speed()
  99     {
 100         return m_defaultSpeed;
 101     }
 102     QSerialPort::FlowControl flow()
 103     {
 104         return m_defaultFlow;
 105     }
 106     QSerialPort::DataBits dataBits()
 107     {
 108         return m_defaultDataBits;
 109     }
 110     QSerialPort::StopBits stopBits()
 111     {
 112         return m_defaultStopBits;
 113     }
 114     QSerialPort::Parity parity()
 115     {
 116         return m_defaultParity;
 117     }
 118     long timeOut()
 119     {
 120         return m_defaultTimeOut;
 121     }
 122
 123     void saveConfig(QSettings *settings) const;
 124     IUAVGadgetConfiguration *clone();
 125
 126 private:
 127     QString m_connectionMode;
 128     QString m_defaultPort;
 129     QSerialPort::BaudRate m_defaultSpeed;
 130     QSerialPort::DataBits m_defaultDataBits;
 131     QSerialPort::FlowControl m_defaultFlow;
 132     QSerialPort::Parity m_defaultParity;
 133     QSerialPort::StopBits m_defaultStopBits;
 134     long m_defaultTimeOut;
 135 };
 136
 137 #endif // GPSDISPLAYGADGETCONFIGURATION_H