streaminterface.h

Go to the documentation of this file.

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

#include "iointerface.h"

enum XsResultValue;

/*! \brief A stream interface
        \details This class provides an interface for dealing with streaming I/O devices, such as a COM
        port or a USB port.
*/
class StreamInterface : public IoInterface
{
public:
        /*! \brief Destroy the stream interface
        */
        inline ~StreamInterface() {}

        /*! \brief Set the read/write timeout to \a ms
                A timeout of 0 means non-blocking operation of writeData() and readData().
        */
        virtual XsResultValue setTimeout (uint32_t ms) = 0;

        /*! \brief The timeout used for read/write operations
        */
        virtual uint32_t getTimeout (void) const = 0;

        XSENS_DISABLE_COPY(StreamInterface)
protected:
        /*! \brief Create a stream interface
        */
        inline StreamInterface() {}
};

#endif  // file guard