mavlink_serial.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017 Daniel Koch and James Jackson, BYU MAGICC Lab.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are met:
7  *
8  * * Redistributions of source code must retain the above copyright notice, this
9  * list of conditions and the following disclaimer.
10  *
11  * * Redistributions in binary form must reproduce the above copyright notice,
12  * this list of conditions and the following disclaimer in the documentation
13  * and/or other materials provided with the distribution.
14  *
15  * * Neither the name of the copyright holder nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
37 #ifndef MAVROSFLIGHT_MAVLINK_SERIAL_H
38 #define MAVROSFLIGHT_MAVLINK_SERIAL_H
39 
41 
42 #include <boost/asio.hpp>
43 #include <boost/function.hpp>
44 
45 #include <string>
46 
47 namespace mavrosflight
48 {
49 class MavlinkSerial : public MavlinkComm
50 {
51 public:
57  MavlinkSerial(std::string port, int baud_rate);
58 
63 
64 private:
65  //===========================================================================
66  // methods
67  //===========================================================================
68 
69  virtual bool is_open();
70  virtual void do_open();
71  virtual void do_close();
72 
76  virtual void do_async_read(const boost::asio::mutable_buffers_1 &buffer,
77  boost::function<void(const boost::system::error_code &, size_t)> handler);
78 
83  virtual void do_async_write(const boost::asio::const_buffers_1 &buffer,
84  boost::function<void(const boost::system::error_code &, size_t)> handler);
85 
86  //===========================================================================
87  // member variables
88  //===========================================================================
89 
90  boost::asio::serial_port serial_port_;
91 
92  std::string port_;
94 };
95 
96 } // namespace mavrosflight
97 
98 #endif // MAVROSFLIGHT_MAVLINK_SERIAL_H
virtual void do_async_read(const boost::asio::mutable_buffers_1 &buffer, boost::function< void(const boost::system::error_code &, size_t)> handler)
Initiate an asynchronous read operation.
boost::asio::serial_port serial_port_
boost serial port object
MavlinkSerial(std::string port, int baud_rate)
Instantiates the class and begins communication on the specified serial port.
virtual void do_async_write(const boost::asio::const_buffers_1 &buffer, boost::function< void(const boost::system::error_code &, size_t)> handler)
Initialize an asynchronous write operation.
~MavlinkSerial()
Stops communication and closes the serial port before the object is destroyed.


rosflight
Author(s): Daniel Koch , James Jackson
autogenerated on Thu Apr 15 2021 05:09:26