CANDriver.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_CANDRIVER_H_
#define _MLAB_CANDRIVER_H_

#include <factory/Factory.h>

#include <can/CANDefs.h>

namespace mira { namespace can {


class MLAB_CAN_EXPORT CANDriver : public Object
{
    MIRA_ABSTRACT_OBJECT(CANDriver);

public:

    CANDriver() : mBaudRate(CAN_BAUDRATE_250K)
    {}

    virtual ~CANDriver() {}

    template<typename Reflector>
    void reflect(Reflector& r)
    {
        r.member("BaudRate", mBaudRate, "The baudrate", CAN_BAUDRATE_250K);
        r.member("Device", mDeviceName, "The device name");
    }


public:

    CANBaudRate getBaudRate() const
    {
        return mBaudRate;
    }

    void setBaudRate(const CANBaudRate& baudRate)
    {
        mBaudRate = baudRate;
    }

    std::string getDeviceName() const
    {
        return mDeviceName;
    }

    void setDeviceName(const std::string& deviceName)
    {
        mDeviceName = deviceName;
    }

    virtual std::string getDriverInfo()
    {
        return "No CAN-Driver information available.";
    }


public:

    virtual void open() = 0;

    virtual void close() = 0;

    virtual CANStatusFlags getStatus() = 0;


public:

    virtual void sendMessage(const CANMessage& msg) = 0;

    virtual bool waitForNextMessage(Duration timeout) = 0;

    virtual void receiveMessage(CANMessage& oMsg, Time& oReceiveTime) = 0;


protected:

    std::string mDeviceName;    
    CANBaudRate mBaudRate;      
};

typedef boost::shared_ptr<CANDriver> CANDriverPtr;


}} // namespaces

#endif