mavsdk::Rtk Class Reference
#include: rtk.h
Service to send RTK corrections to the vehicle.
Data Structures
struct RtcmData
Public Types
| Type | Description |
|---|---|
| enum Result | Possible results returned for rtk requests. |
| std::function< void(Result)> ResultCallback | Callback type for asynchronous Rtk calls. |
Public Member Functions
| Type | Name | Description |
|---|---|---|
| Rtk (System & system) | Constructor. Creates the plugin for a specific System. | |
| Rtk (std::shared_ptr< System > system) | Constructor. Creates the plugin for a specific System. | |
| ~Rtk () override | Destructor (internal use only). | |
| Rtk (const Rtk & other) | Copy constructor. | |
| Result | send_rtcm_data (RtcmData rtcm_data)const | Send RTCM data. |
| const Rtk & | operator= (const Rtk &)=delete | Equality operator (object is not copyable). |
Constructor & Destructor Documentation
Rtk()
mavsdk::Rtk::Rtk(System &system)
Constructor. Creates the plugin for a specific System.
The plugin is typically created as shown below:
auto rtk = Rtk(system);
Parameters
- System& system - The specific system associated with this plugin.
Rtk()
mavsdk::Rtk::Rtk(std::shared_ptr< System > system)
Constructor. Creates the plugin for a specific System.
The plugin is typically created as shown below:
auto rtk = Rtk(system);
Parameters
- std::shared_ptr< System > system - The specific system associated with this plugin.
~Rtk()
mavsdk::Rtk::~Rtk() override
Destructor (internal use only).
Rtk()
mavsdk::Rtk::Rtk(const Rtk &other)
Copy constructor.
Parameters
- const Rtk& other -
Member Typdef Documentation
typedef ResultCallback
using mavsdk::Rtk::ResultCallback = std::function<void(Result)>
Callback type for asynchronous Rtk calls.
Member Enumeration Documentation
enum Result
Possible results returned for rtk requests.
| Value | Description |
|---|---|
Unknown |
Unknown result. |
Success |
Request succeeded. |
TooLong |
Passed data is too long. |
NoSystem |
No system connected. |
ConnectionError |
Connection error. |
Member Function Documentation
send_rtcm_data()
Result mavsdk::Rtk::send_rtcm_data(RtcmData rtcm_data) const
Send RTCM data.
This function is blocking.
Parameters
- RtcmData rtcm_data -
Returns
Result - Result of request.
operator=()
const Rtk& mavsdk::Rtk::operator=(const Rtk &)=delete
Equality operator (object is not copyable).
Parameters
- const Rtk& -
Returns
const Rtk & -