CANToolsView.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_CANTOOLSVIEW_H_
#define _MLAB_CANTOOLSVIEW_H_

#include <fw/Framework.h>
#include <rcp/EditorPart.h>
#include <views/PropertyViewPage.h>
#include <serialization/PropertySerializer.h>

#include <can/CANChannelInterface.h>
#include <can/CANOpenSDOClient.h>
#include <can/CANOpenNMTMaster.h>
#include <gui/views/CANToolsViewPlugin.h>

#include <QTabWidget>
#include <QTimer>

namespace mira { namespace can {


class MLAB_CANGUI_EXPORT CANToolsView : public EditorPart
{
    Q_OBJECT

    MIRA_META_OBJECT(CANToolsView,
        ("Name",        "CAN tools view")
        ("Category",    "CAN")
        ("Description", "Tools for monitoring and setting up CANOpen modules"));

public:

    CANToolsView();
    ~CANToolsView();


    template<typename Reflector>
    void reflect(Reflector& r)
    {}

    void reflect(XMLDeserializer& r);

    void reflect(XMLSerializer& r);

public:

    mira::can::CANChannelInterfacePtr getCANInterface() const
    {
        return mCANInterface;
    }

    Authority& getAuthority()
    {
        return mAuthority;
    }

    mira::can::CANOpenSDOClientPtr getSDOClient() const
    {
        return mSDOClient;
    }

    mira::can::CANOpenNMTMasterPtr getNMTMaster() const
    {
        return mNMTMaster;
    }

    XMLDom& getSavedState()
    {
        return mState;
    }


public:
    template <typename T>
    void addProperties(const std::string& name, T* CLASS)
    {
        PropertySerializer s;
        PropertyNode* p = s.reflectProperties(name, CLASS);
        mProperties.push_back(boost::shared_ptr<PropertyNode>(p));
    }

    virtual Object* getAdapter(const Class& adapter)
    {
        if(adapter == PropertyViewPage::CLASS())
        {
            if (!mProperties.empty())
            {
                mControl->clearPropertyNodes();
                foreach(auto& p, mProperties)
                    mControl->addPropertyNode(p);
                mControl->setWindowTitle(this->windowTitle());
                return mControl;
            }
            else
                return EditorPart::getAdapter(adapter);
        }

        return EditorPart::getAdapter(adapter);
    }

public slots:
    void watchDogTimeout();

protected:

    virtual QWidget* createPartControl();


protected:
    void onHeartbeat(uint8 node, can::CANOpenNodeStatus status);
    void startModule(const can::CANOpenNodeInfo& nodeInfo);
    bool pluginSupportsNode(CANToolsViewPlugin* plugin, const CANOpenNodeInfo& nodeInfo);

    CANOpenNodeInfo mAllNodes[255];
    uint16 mHeartbeatRates[255];
    uint8 mHeartbeatTimeoutCount[255];

protected:
    Authority mAuthority;
    QTabWidget* mTabWidget;
    QTimer *mWatchDogTimer;
    uint32 mHeartbeatID;
    std::map<std::string, QTabWidget*> mCategories;
    std::list<CANToolsViewPlugin*> mPlugins;
    std::list<boost::shared_ptr<PropertyNode>> mProperties;
    PropertyViewPage* mControl;
    XMLDom mState;
    std::map<std::string, int> mTabIndex;

    mira::can::CANChannelInterfacePtr mCANInterface;
    mira::can::CANOpenSDOClientPtr mSDOClient;
    mira::can::CANOpenNMTMasterPtr mNMTMaster;
};


}} // namespaces

#endif