ISSerialPort.h

Go to the documentation of this file.

/*
MIT LICENSE

Copyright (c) 2014-2021 Inertial Sense, Inc. - http://inertialsense.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files(the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions :

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/

#ifndef __ISSERIALPORT_H__
#define __ISSERIALPORT_H__

#include <inttypes.h>
#include <string>
#include <vector>

#include "ISStream.h"
#include "serialPortPlatform.h"

using namespace std;

class cISSerialPort : public cISStream
{
private:
        cISSerialPort(const cISSerialPort& copy); // disable copy constructor

        serial_port_t m_serial;
        int m_timeout;
        bool m_blocking;

public:
        cISSerialPort(serial_port_t* serial = NULL);

        virtual ~cISSerialPort();

        bool Open(const std::string& portName, int baudRate = BAUDRATE_921600, int timeout = 0, bool blocking = false);

        bool IsOpen() { return (serialPortIsOpen(&m_serial) != 0); }

        int Close() OVERRIDE;

        int Read(void* data, int dataLength) OVERRIDE;

        int Write(const void* data, int dataLength) OVERRIDE;

        static void GetComPorts(vector<string>& ports);
};

#endif // __ISSERIALPORT_H__