The Packet Utilities

Namespaces
	AnitaCompress
	AnitaCompress – Tools to unpack compressed waveform data.

Enumerations
enum	CompressErrorCode_t {   COMPRESS_E_OK = 0, COMPRESS_E_PACK = 0x100, COMPRESS_E_BADSIZE, COMPRESS_E_UNPACK,   COMPRESS_E_NO_PEDS, COMPRESS_E_BAD_PEDS, COMPRESS_E_TOO_BIG, COMPRESS_E_BAD_CRC,   COMPRESS_E_BAD_CODE }
	CompressErrorCode_t – Enumeration for compression errors. More...

Functions
void	fillGenericHeader (void *thePtr, PacketCode_t code, unsigned short numBytes)
	fillGenericHeader – utility function More...
int	checkPacket (void *thePtr)
	checkPacket – utility function More...
int	simplePacketCheck (GenericHeader_t *gHdr, PacketCode_t code)
	simplePacketCheck – utility function More...
unsigned char	getVersionId (PacketCode_t code)
	getVersionId – utility function More...
int	getPacketSize (PacketCode_t code)
	getPacketSize – utility function More...
unsigned int	simpleIntCrc (unsigned int *p, unsigned int n)
	simpleIntCrc – utility function More...
const char *	packetCodeAsString (PacketCode_t code)
	packetCodeAsString – utility function More...
int	unzipZippedPacket (ZippedPacket_t *zipPacket, char *output, unsigned int numBytesOut)
	unzipZippedPacket – utility function More...
int	zipBuffer (char *input, char *output, unsigned int inputBytes, unsigned int *outputBytes)
	zipBuffer – utility function More...
int	unzipBuffer (char *input, char *output, unsigned int inputBytes, unsigned int *outputBytes)
	unzipBuffer – utility function More...

Detailed Description

These are utilities for analysing the packetised telemetry data.

Enumeration Type Documentation

enum CompressErrorCode_t

CompressErrorCode_t – Enumeration for compression errors.

Enumeration for compression errors

Definition at line 107 of file AnitaPacketUtil.h.

Function Documentation

int checkPacket

(

void *

thePtr

)

checkPacket – utility function

Utility function useful when looking at telemetry data

Definition at line 180 of file AnitaPacketUtil.cxx.

void fillGenericHeader	(	void *	thePtr,
		PacketCode_t	code,
		unsigned short	numBytes
	)

fillGenericHeader – utility function

Utility function useful when reconstituting raw data.

Definition at line 156 of file AnitaPacketUtil.cxx.

int getPacketSize

(

PacketCode_t

code

)

getPacketSize – utility function

Utility function that returns the size of a packet in bytes

Definition at line 32 of file AnitaPacketUtil.cxx.

unsigned char getVersionId

(

PacketCode_t

code

)

getVersionId – utility function

Utility function that returns a version id

Definition at line 108 of file AnitaPacketUtil.cxx.

const char* packetCodeAsString

(

PacketCode_t

code

)

packetCodeAsString – utility function

Converts packet code enumeration to char string

Definition at line 223 of file AnitaPacketUtil.cxx.

unsigned int simpleIntCrc	(	unsigned int *	p,
		unsigned int	n
	)

simpleIntCrc – utility function

Utility function useful when looking at telemetry data

Definition at line 96 of file AnitaPacketUtil.cxx.

int simplePacketCheck	(	GenericHeader_t *	gHdr,
		PacketCode_t	code
	)

simplePacketCheck – utility function

Utility function that looks at a packet and prints a warning message

Definition at line 13 of file AnitaPacketUtil.cxx.

int unzipBuffer	(	char *	input,
		char *	output,
		unsigned int	inputBytes,
		unsigned int *	outputBytes
	)

unzipBuffer – utility function

Utility function useful when looking at telemetry data

Definition at line 303 of file AnitaPacketUtil.cxx.

int unzipZippedPacket	(	ZippedPacket_t *	zipPacket,
		char *	output,
		unsigned int	numBytesOut
	)

unzipZippedPacket – utility function

Utility function useful when looking at zipped telemetry data

Definition at line 274 of file AnitaPacketUtil.cxx.

int zipBuffer	(	char *	input,
		char *	output,
		unsigned int	inputBytes,
		unsigned int *	outputBytes
	)

zipBuffer – utility function

Utility function useful when looking at telemetry data

Definition at line 287 of file AnitaPacketUtil.cxx.