usbinterface.h

Go to the documentation of this file.

/* +------------------------------------------------------------------------+
   |                     Mobile Robot Programming Toolkit (MRPT)            |
   |                          https://www.mrpt.org/                         |
   |                                                                        |
   | Copyright (c) 2005-2019, Individual contributors, see AUTHORS file     |
   | See: https://www.mrpt.org/Authors - All rights reserved.               |
   | Released under BSD License. See: https://www.mrpt.org/License          |
   +------------------------------------------------------------------------+ */
#ifndef USBINTERFACE_H
#define USBINTERFACE_H

#include <xsens/xstime.h>

#include <stdio.h>
#include <stdlib.h>
#ifdef _WIN32
#include <windows.h>
//# include <sys/types.h>
#else
#include <termios.h>
// these are not required by level 1, but to keep the higher levels
// platform-independent they are put here
#include <stddef.h>
#include <string.h>
#define _strnicmp strncasecmp
#endif

#include <stdio.h>
#include "streaminterface.h"

struct XsPortInfo;

class UsbInterfacePrivate;

class UsbInterface : public StreamInterface
{
   public:
    UsbInterface();
    ~UsbInterface() override;

    XsResultValue open(
        const XsPortInfo& portInfo, uint32_t readBufSize = 0,
        uint32_t writeBufSize = 0) override;
    XsResultValue close(void) override;
    XsResultValue closeUsb(void);
    XsResultValue flushData(void) override;

    bool isOpen(void) const override;
    uint8_t usbBus() const;
    uint8_t usbAddress() const;

    XsResultValue getLastResult(void) const override;

    XsResultValue setTimeout(uint32_t ms) override;
    uint32_t getTimeout(void) const override;

    void setRawIo(bool enable);
    bool getRawIo(void);

    XsResultValue writeData(
        const XsByteArray& data, XsSize* written = nullptr) override;
    XsResultValue readData(XsSize maxLength, XsByteArray& data) override;
    using IoInterface::waitForData;

    // lint -e1411 inherited definitions are also available (see above)
    XsResultValue writeData(
        XsSize length, const void* data, XsSize* written = nullptr);
    XsResultValue readData(
        XsSize maxLength, void* data, XsSize* length = nullptr);
    XsResultValue waitForData(
        XsSize maxLength, void* data, XsSize* length = nullptr);
    // lint +e1411

    void getPortName(XsString& portname) const;

   private:
    XSENS_DISABLE_COPY(UsbInterface)
    UsbInterfacePrivate* d;
};

#endif  // file guard