CANDriverMLCAN.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 _MIRA_CANDRIVERMLCAN_H_
#define _MIRA_CANDRIVERMLCAN_H_

#include <can/CANDriver.h>

namespace mira { namespace can {


class MLAB_CAN_EXPORT CANDriverMLCAN : public CANDriver
{
    MIRA_OBJECT(CANDriverMLCAN);

public:
    CANDriverMLCAN();

    virtual ~CANDriverMLCAN();

public:

    virtual std::string getDriverInfo();

    virtual void open();

    virtual void close();

    virtual CANStatusFlags getStatus();


public:

    virtual void sendMessage(const CANMessage& msg);

    virtual bool waitForNextMessage(Duration timeout);

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

private:
    bool extractMessageFromBuffer();

private:
    struct MLCANContext;
    MLCANContext* mContext;
};


}} // namespace

#endif