das2/packet.h File Reference

---

Detailed Description

#include <das2/plane.h>

Go to the source code of this file.

Data Structures
struct	PktDesc
	Hold information for a single packet type in a Das2 stream. More...
Defines
#define	MAXPLANES   100
	maximum planes allowed in a packet
Functions
void	del_PktDesc (PktDesc *pThis)
	Free a packet descriptor and all it's contained objects.
bool	PktDesc_equalFormat (const PktDesc *pPd1, const PktDesc *pPd2)
	Check for packet descriptor format equality.
PlaneDesc *	PktDesc_getPlaneByName (PktDesc *pThis, const char *name)
	Get a Plane Descriptor for the plane with the name name.

---

Function Documentation

void del_PktDesc

(

PktDesc *

pThis

)

Free a packet descriptor and all it's contained objects.

Parameters:

pThis

The packet descriptor to free, the caller should set the pointer to NULL after this call.

bool PktDesc_equalFormat	(	const PktDesc *	pPd1,
		const PktDesc *	pPd2
	)

Check for packet descriptor format equality.

This function checks to see if two packet descriptors define the same data note that the StreamDesc parent of each need not be the same, nor are the descriptors required to have the same current data values.

Parameters:

	pPdOne
	pPdTwo

Returns:

true if both packet descriptors provide the same definition, false otherwise

PlaneDesc* PktDesc_getPlaneByName	(	PktDesc *	pThis,
		const char *	name
	)

Get a Plane Descriptor for the plane with the name name.

Returns:

A pointer to the plane, or NULL if no plane with the given name is present in the packet descriptor