rtcmDecoder.hpp File Reference

Data Structures
struct	SignalInfo
struct	RtcmStationInfo
struct	RtcmDecoder

Functions
const RtcmStationInfo *	selectRtcmStationInfoForMetadata (const map< int, RtcmStationInfo > &stationInfoMap, int lastReferenceStationId)
uint32_t	getbitu (const unsigned char *buff, int pos, int len)
	extract unsigned bits from byte data
int32_t	getbits (const unsigned char *buff, int pos, int len, bool *failure_ptr=nullptr)
	extract signed bits from byte data
uint32_t	getbituInc (const unsigned char *buff, int &pos, int len)
	increasingly extract unsigned bits from byte data
int32_t	getbitsInc (const unsigned char *buff, int &pos, int len, bool *failure_ptr=nullptr)
	increasingly extract signed bits from byte data
bool	getbituIncChecked (const unsigned char *buff, int buffBits, int &pos, int len, uint32_t &out)
	Bounds-checked variant of getbituInc().
bool	getbitsIncChecked (const unsigned char *buff, int buffBits, int &pos, int len, int32_t &out, bool *failure_ptr=nullptr)
	Bounds-checked variant of getbitsInc().
int32_t	getbitg (const unsigned char *buff, int pos, int len)
	extract sign-magnitude bits applied in GLO nav messages from byte data
int32_t	getbitgInc (const unsigned char *buff, int &pos, int len)
	increasingly extract sign-magnitude bits applied in GLO nav messages from byte data
int32_t	getbitgInc (vector< unsigned char > &buff, int &pos, int len)
	increasingly extract sign-magnitude bits applied in GLO nav messages from RTCM messages
uint32_t	getbitu (vector< unsigned char > &buff, int pos, int len)
	extract unsigned bits from RTCM messages
uint32_t	getbituInc (vector< unsigned char > &buff, int &pos, int len)
	increasingly extract unsigned bits from RTCM messages
int32_t	getbitsInc (vector< unsigned char > &buff, int &pos, int len, bool *failure_ptr=nullptr)
	increasingly extract signed bits from RTCM messages
bool	getbituIncChecked (vector< unsigned char > &buff, int &pos, int len, uint32_t &out)
	Vector overload of the bounds-checked unsigned incremental bit reader.
bool	getbitsIncChecked (vector< unsigned char > &buff, int &pos, int len, int32_t &out, bool *failure_ptr=nullptr)
	Vector overload of the bounds-checked signed incremental bit reader.
double	getbituIncScale (vector< unsigned char > &buff, int &pos, int len, double scale)
	increasingly extract unsigned bits from RTCM messages with scale factor/resolution applied
double	getbitsIncScale (vector< unsigned char > &buff, int &pos, int len, double scale, bool *failure_ptr=nullptr)
	increasingly extract signed bits from RTCM messages with scale factor/resolution applied

Function Documentation

getbitg()

int32_t getbitg	(	const unsigned char *	buff,
		int	pos,
		int	len )

extract sign-magnitude bits applied in GLO nav messages from byte data

Parameters

buff	byte data
pos	bit position from start of data (bits)
len	bit length (bits) (len<=32)

Here is the call graph for this function:

Here is the caller graph for this function:

getbitgInc() [1/2]

int32_t getbitgInc	(	const unsigned char *	buff,
		int &	pos,
		int	len )

increasingly extract sign-magnitude bits applied in GLO nav messages from byte data

Parameters

buff	byte data
pos	bit position from start of data (bits)
len	bit length (bits) (len<=32)

Here is the call graph for this function:

Here is the caller graph for this function:

getbitgInc() [2/2]

int32_t getbitgInc	(	vector< unsigned char > &	buff,
		int &	pos,
		int	len )

increasingly extract sign-magnitude bits applied in GLO nav messages from RTCM messages

Parameters

buff	byte data
pos	bit position from start of data (bits)
len	bit length (bits) (len<=32)

Here is the call graph for this function:

getbits()

int32_t getbits	(	const unsigned char *	buff,
		int	pos,
		int	len,
		bool *	failure_ptr = nullptr )

extract signed bits from byte data

Parameters

buff	byte data
pos	bit position from start of data (bits)
len	bit length (bits) (len<=32)
failure_ptr	pointer for failure flag

Here is the call graph for this function:

Here is the caller graph for this function:

getbitsInc() [1/2]

int32_t getbitsInc	(	const unsigned char *	buff,
		int &	pos,
		int	len,
		bool *	failure_ptr = nullptr )

increasingly extract signed bits from byte data

Parameters

buff	byte data
pos	bit position from start of data (bits)
len	bit length (bits) (len<=32)
failure_ptr	pointer for failure flag

Here is the call graph for this function:

Here is the caller graph for this function:

getbitsInc() [2/2]

int32_t getbitsInc	(	vector< unsigned char > &	buff,
		int &	pos,
		int	len,
		bool *	failure_ptr = nullptr )

increasingly extract signed bits from RTCM messages

Parameters

buff	byte data
pos	bit position from start of data (bits)
len	bit length (bits) (len<=32)
failure_ptr	pointer for failure flag

Here is the call graph for this function:

getbitsIncChecked() [1/2]

bool getbitsIncChecked	(	const unsigned char *	buff,
		int	buffBits,
		int &	pos,
		int	len,
		int32_t &	out,
		bool *	failure_ptr = nullptr )

Bounds-checked variant of getbitsInc().

Returns false instead of reading when the requested bit range is outside the supplied buffer bounds. The optional failure pointer is forwarded to the signed extractor when the read is valid.

Parameters

buff	byte data
pos	bit position from start of data (bits)
len	bit length (bits) (len<=32)
failure_ptr	pointer for failure flag

Here is the call graph for this function:

Here is the caller graph for this function:

getbitsIncChecked() [2/2]

bool getbitsIncChecked	(	vector< unsigned char > &	buff,
		int &	pos,
		int	len,
		int32_t &	out,
		bool *	failure_ptr = nullptr )

Vector overload of the bounds-checked signed incremental bit reader.

Uses the vector size to derive the valid bit range before delegating to the raw-buffer implementation.

Parameters

buff	byte data
pos	bit position from start of data (bits)
len	bit length (bits) (len<=32)
failure_ptr	pointer for failure flag

Here is the call graph for this function:

getbitsIncScale()

double getbitsIncScale	(	vector< unsigned char > &	buff,
		int &	pos,
		int	len,
		double	scale,
		bool *	failure_ptr = nullptr )

increasingly extract signed bits from RTCM messages with scale factor/resolution applied

Parameters

buff	byte data
pos	bit position from start of data (bits)
len	bit length (bits) (len<=32)
scale	scale factor/resolution
failure_ptr	pointer for failure flag

Here is the call graph for this function:

Here is the caller graph for this function:

getbitu() [1/2]

uint32_t getbitu	(	const unsigned char *	buff,
		int	pos,
		int	len )

extract unsigned bits from byte data

Parameters

buff	byte data
pos	bit position from start of data (bits)
len	bit length (bits) (len<=32)

Here is the caller graph for this function:

getbitu() [2/2]

uint32_t getbitu	(	vector< unsigned char > &	buff,
		int	pos,
		int	len )

extract unsigned bits from RTCM messages

Parameters

buff	RTCM messages
pos	bit position from start of data (bits)
len	bit length (bits) (len<=32)

Here is the call graph for this function:

getbituInc() [1/2]

uint32_t getbituInc	(	const unsigned char *	buff,
		int &	pos,
		int	len )

increasingly extract unsigned bits from byte data

Parameters

buff	byte data
pos	bit position from start of data (bits)
len	bit length (bits) (len<=32)

Here is the call graph for this function:

getbituInc() [2/2]

uint32_t getbituInc	(	vector< unsigned char > &	buff,
		int &	pos,
		int	len )

increasingly extract unsigned bits from RTCM messages

Parameters

buff	byte data
pos	bit position from start of data (bits)
len	bit length (bits) (len<=32)

Here is the call graph for this function:

getbituIncChecked() [1/2]

bool getbituIncChecked	(	const unsigned char *	buff,
		int	buffBits,
		int &	pos,
		int	len,
		uint32_t &	out )

Bounds-checked variant of getbituInc().

Returns false instead of reading when the requested bit range is outside the supplied buffer bounds. Intended for future decoder hardening paths that need to reject truncated or malformed RTCM payloads safely.

Parameters

buff	byte data
pos	bit position from start of data (bits)
len	bit length (bits) (len<=32)

Here is the call graph for this function:

Here is the caller graph for this function:

getbituIncChecked() [2/2]

bool getbituIncChecked	(	vector< unsigned char > &	buff,
		int &	pos,
		int	len,
		uint32_t &	out )

Vector overload of the bounds-checked unsigned incremental bit reader.

Uses the vector size to derive the valid bit range before delegating to the raw-buffer implementation.

Parameters

buff	byte data
pos	bit position from start of data (bits)
len	bit length (bits) (len<=32)

Here is the call graph for this function:

getbituIncScale()

double getbituIncScale	(	vector< unsigned char > &	buff,
		int &	pos,
		int	len,
		double	scale )

increasingly extract unsigned bits from RTCM messages with scale factor/resolution applied

Parameters

buff	byte data
pos	bit position from start of data (bits)
len	bit length (bits) (len<=32)
scale	scale factor/resolution

Here is the call graph for this function:

Here is the caller graph for this function:

selectRtcmStationInfoForMetadata()

const RtcmStationInfo * selectRtcmStationInfoForMetadata ( const map< int, RtcmStationInfo > & stationInfoMap, int lastReferenceStationId )

inline

Here is the caller graph for this function: