UBX::CheckedValsetBatch< Capacity > Struct Template Reference

#include <UBXConfigKeys.h>

Public Member Functions
std::span< const uint8_t >	payload () const
std::span< const uint8_t >	entries () const
	The appended key/value entries, without the header.
bool	append (uint32_t key, uint32_t value)

Public Attributes
std::array< uint8_t, Capacity >	bytes {0, 1}
size_t	size = 4
bool	valid = true

Detailed Description

template<size_t Capacity>
struct UBX::CheckedValsetBatch< Capacity >

A CFG-VALSET payload for the RAM layer. An append error invalidates the entire batch, including previously appended entries.

Definition at line 274 of file UBXConfigKeys.h.

Member Function Documentation

append()

template<size_t Capacity>

bool UBX::CheckedValsetBatch< Capacity >::append ( uint32_t  key, uint32_t  value  )

inline

Definition at line 289 of file UBXConfigKeys.h.

References UBX::CheckedValsetBatch< Capacity >::bytes, UBX::configurationValueBytes(), UBX::CheckedValsetBatch< Capacity >::size, UBX::CheckedValsetBatch< Capacity >::valid, and LittleEndian::write().

entries()

template<size_t Capacity>

std::span< const uint8_t > UBX::CheckedValsetBatch< Capacity >::entries ( ) const

inline

The appended key/value entries, without the header.

Definition at line 287 of file UBXConfigKeys.h.

References UBX::CheckedValsetBatch< Capacity >::bytes, and UBX::CheckedValsetBatch< Capacity >::size.

payload()

template<size_t Capacity>

std::span< const uint8_t > UBX::CheckedValsetBatch< Capacity >::payload ( ) const

inline

Definition at line 281 of file UBXConfigKeys.h.

References UBX::CheckedValsetBatch< Capacity >::bytes, UBX::CheckedValsetBatch< Capacity >::size, and UBX::CheckedValsetBatch< Capacity >::valid.

Member Data Documentation

bytes

template<size_t Capacity>

std::array<uint8_t, Capacity> UBX::CheckedValsetBatch< Capacity >::bytes {0, 1}

Definition at line 277 of file UBXConfigKeys.h.

Referenced by UBX::CheckedValsetBatch< Capacity >::append(), UBX::CheckedValsetBatch< Capacity >::entries(), and UBX::CheckedValsetBatch< Capacity >::payload().

size

template<size_t Capacity>

size_t UBX::CheckedValsetBatch< Capacity >::size = 4

Definition at line 278 of file UBXConfigKeys.h.

Referenced by UBX::CheckedValsetBatch< Capacity >::append(), UBX::CheckedValsetBatch< Capacity >::entries(), and UBX::CheckedValsetBatch< Capacity >::payload().

valid

template<size_t Capacity>

bool UBX::CheckedValsetBatch< Capacity >::valid = true

Definition at line 279 of file UBXConfigKeys.h.

Referenced by UBX::CheckedValsetBatch< Capacity >::append(), and UBX::CheckedValsetBatch< Capacity >::payload().

---

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

• src/GPS/Core/Protocols/UBX/UBXConfigKeys.h