waterlinked::sonar::rip Namespace Reference

Classes
struct	Decoded
	Result of Decoder::decode(). More...
class	Decoder
	Range Image Protocol codec (https://docs.waterlinked.com/sonar-3d/sonar-3d-15-api/). More...

Enumerations
enum class	DecodeStatus : std::uint8_t {   OK , UNKNOWN_TYPE , BAD_MAGIC , BAD_LENGTH ,   CRC_MISMATCH , DECOMPRESS_FAILED , PARSE_FAILED }
	Outcome of decoding one datagram. More...

Functions
const char *	to_string (DecodeStatus status)
	Human-readable name for a decode status; a static string, never null.

Enumeration Type Documentation

DecodeStatus

enum class waterlinked::sonar::rip::DecodeStatus : std::uint8_t

strong

Outcome of decoding one datagram.

Enumerator
OK
UNKNOWN_TYPE	Valid packet carrying a message type other than the three published ones. The device routinely sends internal types; skip quietly.
BAD_MAGIC
BAD_LENGTH
CRC_MISMATCH
DECOMPRESS_FAILED
PARSE_FAILED

Function Documentation

to_string()

const char * waterlinked::sonar::rip::to_string

(

DecodeStatus

status

)

Human-readable name for a decode status; a static string, never null.