Program Listing for File serial.hpp

↰ Return to documentation for file (/tmp/ws/src/ros2_robotiq_gripper/robotiq_driver/include/robotiq_driver/serial.hpp)

// Copyright (c) 2023 PickNik, Inc.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//    * Redistributions of source code must retain the above copyright
//      notice, this list of conditions and the following disclaimer.
//
//    * Redistributions in binary form must reproduce the above copyright
//      notice, this list of conditions and the following disclaimer in the
//      documentation and/or other materials provided with the distribution.
//
//    * Neither the name of the {copyright_holder} nor the names of its
//      contributors may be used to endorse or promote products derived from
//      this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.

#pragma once

#include <chrono>
#include <cstdint>
#include <string>
#include <vector>

namespace robotiq_driver
{
class Serial
{
public:
  virtual ~Serial() = default;

  virtual void open() = 0;

  [[nodiscard]] virtual bool is_open() const = 0;

  virtual void close() = 0;

  [[nodiscard]] virtual std::vector<uint8_t> read(size_t size) = 0;

  virtual void write(const std::vector<uint8_t>& data) = 0;

  virtual void set_port(const std::string& port) = 0;

  [[nodiscard]] virtual std::string get_port() const = 0;

  virtual void set_timeout(const std::chrono::milliseconds timeout) = 0;

  [[nodiscard]] virtual std::chrono::milliseconds get_timeout() const = 0;

  virtual void set_baudrate(uint32_t baudrate) = 0;

  [[nodiscard]] virtual uint32_t get_baudrate() const = 0;
};
}  // namespace robotiq_driver