CANMessageViewerPlugin.h

Go to the documentation of this file.

/*
 * Copyright (C) 2012 MetraLabs GmbH (MLAB), GERMANY.
 * All rights reserved.
 * Contact: info@MetraLabs.com
 *
 * Commercial Usage:
 *   Licensees holding valid commercial licenses may use this file in
 *   accordance with the commercial license agreement provided with the
 *   software or, alternatively, in accordance with the terms contained in
 *   a written agreement between you and MetraLabs.
 *
 * GNU General Public License Usage:
 *   Alternatively, this file may be used under the terms of the GNU
 *   General Public License version 3.0 as published by the Free Software
 *   Foundation and appearing in the file LICENSE.GPL3 included in the
 *   packaging of this file.  Please review the following information to
 *   ensure the GNU General Public License version 3.0 requirements will be
 *   met: http://www.gnu.org/copyleft/gpl.html.
 *   Alternatively you may (at your option) use any later version of the GNU
 *   General Public License if such license has been publicly approved by
 *   MetraLabs (or its successors, if any).
 *
 * IN NO EVENT SHALL "MLAB" BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
 * SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE
 * OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLABS" HAS BEEN
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * "MLAB" SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS ON AN
 * "AS IS" BASIS, AND "MLAB" HAS NO OBLIGATION TO PROVIDE MAINTENANCE,
 * SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
 */

#ifndef _MLAB_CANMESSAGEVIEWERPLUGIN_H_
#define _MLAB_CANMESSAGEVIEWERPLUGIN_H_

#ifndef Q_MOC_RUN
#include <boost/thread/mutex.hpp>
#endif

#include <QTableWidget>

#include <gui/views/CANToolsView.h>
#include <gui/views/CANToolsViewPlugin.h>

namespace mira { namespace can {


class CANMessageViewerPlugin : public CANToolsViewPlugin
{
    Q_OBJECT;
    MIRA_META_OBJECT(CANMessageViewerPlugin,
            ("Name",        "CAN message viewer")
            ("Category",    "CAN")
            ("Description", "Lists all received can messages and displays info")
            ("Title",       "Messages"));
public:
    ~CANMessageViewerPlugin();

public slots:

    void removeRow();
    void showContextMenu(const QPoint& pos);
    void updateWidget();

protected:

    virtual void initialize();
    void onCanMessage(const can::CANMessage& message, const Time& timestamp);
    void addRow(const QString& pdo);
    void createCombo(int row);

protected:

    uint32 messageRecvListenerId;
    boost::mutex mUpdateMutex;
    QTableWidget* mPDOTable;
    QTableWidget* mPDOReadTable;
    QTimer *mUpdateTimer;

    struct QueueEntry
    {
        can::CANMessage message;
        Time timestamp;
    };
    QList<QueueEntry> mCANMessageQueue;

    struct MessageInfo
    {
        MessageInfo(const Time& t = Time::now()) :
            count(1),
            last(t),
            minInterval(std::numeric_limits<uint32>::max()),
            maxInterval(0) {}
        uint32 count;
        Time last;
        uint32 minInterval;
        uint32 maxInterval;
    };
    std::map<uint32, MessageInfo> mPDOEntries;

    struct CANInfo 
    {
        int start;
        int length;
        std::string description;
        std::string ID;

        template <typename Reflector>
        void reflect(Reflector& r)
        {
            r.member("Start", start, "");
            r.member("ID", ID, "");
            r.member("Length", length, "");
            r.member("Description", description, "");
        }
    };
};


}} // namespaces

#endif /* CANMESSAGEVIEWERPLUGIN_H_ */