das2/packet.h

Go to the documentation of this file.

#ifndef _das2_packet_h_
#define _das2_packet_h_

#include <das2/plane.h>

#define MAXPLANES 100


typedef struct packet_descriptor {
    Descriptor base;
    
    int id;
    
    size_t uPlanes;
    PlaneDesc* planes[MAXPLANES];
    
    /* Set to true when encode is called, make sure data doesn't go 
     * out the door unless the descriptor is sent first */
    bool bSentHdr;
    
    void* pUser;  
} PktDesc;


PktDesc* new_PktDesc(void); 

PktDesc* new_PktDesc_xml(DasBuf* pBuf, Descriptor* pParent, int nPktId);

void del_PktDesc(PktDesc* pThis);

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

int PktDesc_getId(const PktDesc* pThis);

size_t PktDesc_recBytes(const PktDesc* pThis);


size_t PktDesc_getNPlanes(const PktDesc* pThis);

size_t PktDesc_getNPlanesOfType(const PktDesc* pThis, plane_type_t pt);

int PktDesc_addPlane(PktDesc* pThis, PlaneDesc* pPlane);


ErrorCode PktDesc_copyPlanes(PktDesc* pThis,  const PktDesc* pOther);

bool PktDesc_validate(PktDesc* pThis );

plane_type_t PktDesc_getPlaneType(const PktDesc* pThis, int iPlane);


PlaneDesc* PktDesc_getPlane(PktDesc* pThis, int iplane);

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

int PktDesc_getPlaneNum(const PktDesc* pThis, plane_type_t ptype, int iRelIndex);

int PktDesc_getPlaneNumByName(
   PktDesc* pThis, const char* name, plane_type_t planeType
);

PlaneDesc* PktDesc_getXPlane(PktDesc* pThis);

ErrorCode PktDesc_encode(const PktDesc* pThis, DasBuf* pBuf);

ErrorCode PktDesc_encodeData(const PktDesc* pThis, DasBuf* pBuf);

ErrorCode PktDesc_decodeData(PktDesc* pThis, DasBuf* pBuf);

ErrorCode PktDesc_setValue(PktDesc* pThis, size_t uPlane, size_t uItem, double val);

ErrorCode PktDesc_setValues(PktDesc* pThis, size_t uPlane, double* pVals);


#endif /* _das2_packet_h_ */

---