Static Public Member Functions | List of all members
ublox::Serializer< T > Struct Template Reference

Encodes and decodes messages. More...

#include <serialization.h>

Static Public Member Functions

static void read (const uint8_t *data, uint32_t count, typename boost::call_traits< T >::reference message)
 Decode the message payload from the data buffer. More...
 
static uint32_t serializedLength (typename boost::call_traits< T >::param_type message)
 Get the length of the message payload in bytes. More...
 
static void write (uint8_t *data, uint32_t size, typename boost::call_traits< T >::param_type message)
 Encode the message payload as a byte array. More...
 

Detailed Description

template<typename T>
struct ublox::Serializer< T >

Encodes and decodes messages.

Definition at line 69 of file serialization.h.

Member Function Documentation

template<typename T >
void ublox::Serializer< T >::read ( const uint8_t *  data,
uint32_t  count,
typename boost::call_traits< T >::reference  message 
)
static

Decode the message payload from the data buffer.

Parameters
dataa pointer to the start of the message payload
countthe number of bytes in the message payload
messagethe output message

Definition at line 40 of file serialization_ros.h.

template<typename T >
uint32_t ublox::Serializer< T >::serializedLength ( typename boost::call_traits< T >::param_type  message)
static

Get the length of the message payload in bytes.

The payload does not include the header or checksum.

Parameters
messagethe message to get the length of
Returns
the length of the message in bytes.

Definition at line 47 of file serialization_ros.h.

template<typename T >
void ublox::Serializer< T >::write ( uint8_t *  data,
uint32_t  size,
typename boost::call_traits< T >::param_type  message 
)
static

Encode the message payload as a byte array.

Parameters
dataa buffer to fill with the message payload bytes
sizethe length of the buffer
messagethe output message

Definition at line 53 of file serialization_ros.h.


The documentation for this struct was generated from the following files:


ublox_serialization
Author(s): Johannes Meyer
autogenerated on Thu Jan 28 2021 03:13:50