new connection interface

2016-06-15 18:22:39 +02:00
parent 7192e11f38
commit 4553dd59ee
3 changed files with 301 additions and 4 deletions
@@ -1,4 +1,24 @@
 #ifndef CANCONCONST_H
 #define CANCONCONST_H

+namespace CANCon {
+
+    /**
+     * @brief The status enum
+     */
+    enum status
+    {
+        NOT_CONNECTED,  /*!< device is not connected */
+        CONNECTED       /*!< device is connected */
+    };
+
+    enum type
+    {
+        GVRET_SERIAL,
+        KVASER,
+        SOCKETCAN,
+        NONE
+    };
+}
+
 #endif // CANCONCONST_H
@@ -1,6 +1,103 @@
 #include "canconnection.h"

-CanConnection::CanConnection()
+CANConnection::CANConnection(QString pPort, CANCon::type pType, int pNumBuses) :
+    mQueue(),
+    mNumBuses(pNumBuses),
+    mPort(pPort),
+    mType(pType),
+    mIsCapSuspended(false),
+    mStatus(CANCon::NOT_CONNECTED)
 {
+    qDebug() << "CANConnection()";

+    /* register types */
+    qRegisterMetaType<CANBus>("CANBus");
+    qRegisterMetaType<CANCon::status>("CANCon::status");
+
+    mBus        = new CANBus[mNumBuses];
+    mConfigured = new bool[mNumBuses];
+
+    for(int i=0 ; i<mNumBuses ; i++)
+        mConfigured[i] = false;
 }
+
+
+CANConnection::~CANConnection()
+{
+    qDebug() << "~CANConnection()";
+
+    delete[] mBus;
+    mBus = NULL;
+    delete[] mConfigured;
+    mConfigured = NULL;
+}
+
+
+int CANConnection::getNumBuses() {
+    return mNumBuses;
+}
+
+
+bool CANConnection::isConfigured(int pBusId) {
+    if( pBusId < 0 || pBusId >= mNumBuses)
+        return false;
+    return mConfigured[pBusId];
+}
+
+void CANConnection::setConfigured(int pBusId, bool pConfigured) {
+    if( pBusId < 0 || pBusId >= mNumBuses)
+        return;
+    mConfigured[pBusId] = pConfigured;
+}
+
+
+bool CANConnection::getBusConfig(int pBusId, CANBus& pBus) {
+    if( pBusId < 0 || pBusId >= mNumBuses || !isConfigured(pBusId))
+        return false;
+
+    pBus = mBus[pBusId];
+    return true;
+}
+
+
+void CANConnection::setBusConfig(int pBusId, CANBus& pBus) {
+    if( pBusId < 0 || pBusId >= mNumBuses)
+        return;
+
+    mConfigured[pBusId] = true;
+    mBus[pBusId] = pBus;
+}
+
+
+QString CANConnection::getPort() {
+    return mPort;
+}
+
+
+LFQueue<CANFrame>& CANConnection::getQueue() {
+    return mQueue;
+}
+
+
+CANCon::type CANConnection::getType() {
+    return mType;
+}
+
+
+CANCon::status CANConnection::getStatus() {
+    return (CANCon::status) mStatus.load();
+}
+
+
+void CANConnection::setStatus(CANCon::status pStatus) {
+    mStatus.store(pStatus);
+}
+
+bool CANConnection::isCapSuspended() {
+    return mIsCapSuspended;
+}
+
+void CANConnection::setCapSuspended(bool pIsSuspended) {
+    mIsCapSuspended = pIsSuspended;
+}
+
@@ -1,11 +1,191 @@
 #ifndef CANCONNECTION_H
 #define CANCONNECTION_H

+#include <Qt>
+#include <QObject>
+#include "utils/lfqueue.h"
+#include "can_structs.h"
+#include "canbus.h"
+#include "canconconst.h"

-class CanConnection
+
+class CANConnection : public QObject
 {
+    Q_OBJECT
+
 public:
-    CanConnection();
+
+    /**
+     * @brief CANConnection constructor
+     * @param pPort: string containing port name
+     * @param pType: the type of connection @ref CANCon::type
+     * @param pNumBuses: the number of buses the device has
+     */
+    CANConnection(QString pPort, CANCon::type pType, int pNumBuses);
+    /**
+     * @brief CANConnection destructor
+     */
+
+    virtual ~CANConnection();
+
+    /**
+     * @brief getNumBuses
+     * @return returns the number of buses of the device
+     * @note multithread safe
+     */
+    int getNumBuses();
+
+    /**
+     * @brief getPort
+     * @return returns the port name of the device
+     * @note multithread safe
+     */
+    QString getPort();
+
+    /**
+     * @brief getQueue is call by reader to get a reference on the queue to monitor
+     * @return the lock free queue of the device
+     * @note multithread safe
+     */
+    LFQueue<CANFrame>& getQueue();
+
+    /**
+     * @brief getType
+     * @return the @ref CANCon::type of the device
+     * @note multithread safe
+     */
+    CANCon::type getType();
+
+    /**
+     * @brief getStatus
+     * @return the @ref CANCon::status of the device (either connected or not)
+     * @note multithread safe
+     */
+    CANCon::status getStatus();
+
+    /**
+     * @brief start the device
+     * @note start a working thread here if needed
+     */
+    virtual void start() = 0;
+
+    /**
+     * @brief stop the device
+     * @note stop the working thread here if one has been started
+     */
+    virtual void stop() = 0;
+
+
+signals:
+    void error(const QString &);
+    void deviceInfo(int, int); //First param = driver version (or version of whatever you want), second param a status byte
+
+    //bus number, bus speed, status (bit 0 = enabled, 1 = single wire, 2 = listen only)
+    //3 = Use value stored for enabled, 4 = use value passed for single wire, 5 = use value passed for listen only
+    //6 = use value passed for speed. This allows bus status to be updated but set that some things aren't really
+    //being passed. Just set for things that really are being updated.
+    void busStatus(int, int, int);
+
+    /**
+     * @brief event sent when the CANCon::status of the connection changes (connected->not_connected or the other way round)
+     * @param pStatus: the new status of the device
+     */
+    void status(CANCon::status pStatus);
+
+
+public slots:
+
+    virtual void sendFrame(const CANFrame *) = 0;
+    virtual void sendFrameBatch(const QList<CANFrame> *) = 0;
+
+    /**
+     * @brief setBusSettings
+     * @param pBusIdx: the index of the bus for which settings have to be set
+     * @param pBus: the settings to set
+     */
+    virtual void setBusSettings(int pBusIdx, CANBus pBus) = 0;
+
+    /**
+     * @brief getBusSettings
+     * @param pBusIdx: the index of the bus for which settings have to be retrieved
+     * @param pBus: the CANBus struct to fill with information
+     * @return true if operation succeeds, false if pBusIdx is invalid or bus has not been configured yet
+     */
+    virtual bool getBusSettings(int pBusIdx, CANBus& pBus) = 0;
+
+    /**
+     * @brief suspends/restarts data capture
+     * @param pSuspend: suspends capture if true else restarts it
+     * @note the caller will not access the queue when capture is suspended, so it is safe for callee to flush the queue
+     */
+    virtual void suspend(bool pSuspend) = 0;
+
+protected:
+
+    /**
+     * @brief setStatus
+     * @param pStatus: the status to set
+     * @note multithread safe (can be used while another thread calls @ref getStatus)
+     */
+    void setStatus(CANCon::status pStatus);
+
+    /**
+     * @brief isConfigured
+     * @param pBusId
+     * @return true if bus is configured
+     * @note NOT multithread safe
+     */
+    bool isConfigured(int pBusId);
+
+    /**
+     * @brief setConfigured
+     * @param pBusId
+     * @param pConfigured
+     * @note it is not necessary to call this function to set pBusId configured, it is enough to call @ref setBusConfig
+     * @note NOT multithread safe
+     */
+    void setConfigured(int pBusId, bool pConfigured);
+
+    /**
+     * @brief getBusConfig
+     * @param pBusId
+     * @param pBus
+     * @return true if operation succeeds, false if pBusIdx is invalid or bus has not been configured yet
+     * @note NOT multithread safe
+     */
+    bool getBusConfig(int pBusId, CANBus& pBus);
+
+    /**
+     * @brief setBusConfig
+     * @param pBusId: the index of the bus for which settings have to be set
+     * @param pBus: the settings to set
+     * @note NOT multithread safe
+     */
+    void setBusConfig(int pBusId, CANBus& pBus);
+
+    /**
+     * @brief isCapSuspended
+     * @return true if the capture is suspended
+     * @note NOT multithread safe
+     */
+    bool isCapSuspended();
+
+    /**
+     * @brief setCapSuspended
+     * @param pIsSuspended
+     * @note NOT multithread safe
+     */
+    void setCapSuspended(bool pIsSuspended);
+
+private:
+    CANBus*             mBus;
+    bool*               mConfigured;
+    LFQueue<CANFrame>   mQueue;
+    const int           mNumBuses;
+    const QString       mPort;
+    const CANCon::type  mType;
+    bool                mIsCapSuspended;
+    QAtomicInt          mStatus;
 };

 #endif // CANCONNECTION_H