Public Member Functions | Public Attributes | List of all members
ublox::Options Struct Reference

Options for the Reader and Writer for encoding and decoding messages. More...

#include <serialization.h>

Public Member Functions

 Options ()
 
int wrapper_length ()
 Get the number of bytes in the header and footer. More...
 

Public Attributes

uint8_t checksum_length
 The length of the checksum in bytes. More...
 
uint8_t header_length
 The length of the message header in bytes (everything before the payload) More...
 
uint32_t max_payload_length
 The maximum payload length. More...
 
uint8_t sync_a
 The sync_a byte value identifying the start of a message. More...
 
uint8_t sync_b
 The sync_b byte value identifying the start of a message. More...
 

Detailed Description

Options for the Reader and Writer for encoding and decoding messages.

Definition at line 142 of file serialization.h.

Constructor & Destructor Documentation

◆ Options()

ublox::Options::Options ( )
inline

The default options for a u-blox message.

Definition at line 146 of file serialization.h.

Member Function Documentation

◆ wrapper_length()

int ublox::Options::wrapper_length ( )
inline

Get the number of bytes in the header and footer.

Returns
the number of bytes in the header and footer

Definition at line 164 of file serialization.h.

Member Data Documentation

◆ checksum_length

uint8_t ublox::Options::checksum_length

The length of the checksum in bytes.

Definition at line 158 of file serialization.h.

◆ header_length

uint8_t ublox::Options::header_length

The length of the message header in bytes (everything before the payload)

Definition at line 156 of file serialization.h.

◆ max_payload_length

uint32_t ublox::Options::max_payload_length

The maximum payload length.

Definition at line 154 of file serialization.h.

◆ sync_a

uint8_t ublox::Options::sync_a

The sync_a byte value identifying the start of a message.

Definition at line 150 of file serialization.h.

◆ sync_b

uint8_t ublox::Options::sync_b

The sync_b byte value identifying the start of a message.

Definition at line 152 of file serialization.h.


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


ublox_serialization
Author(s): Johannes Meyer
autogenerated on Wed Dec 7 2022 03:47:50