packet.h

Go to the documentation of this file.

/* Copyright (C) 2004-2017 Jeremy Faden <jeremy-faden@uiowa.edu> 
 *                         Chris Piker <chris-piker@uiowa.edu>
 *
 * This file is part of libdas2, the Core Das2 C Library.
 * 
 * Libdas2 is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 as published
 * by the Free Software Foundation.
 *
 * Libdas2 is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for
 * more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 2.1 along with libdas2; if not, see <http://www.gnu.org/licenses/>. 
 */


#ifndef _das_packet_h_
#define _das_packet_h_

#include <das2/plane.h>

#ifdef __cplusplus
extern "C" {
#endif

#define MAXPLANES 100

typedef struct packet_descriptor {
    DasDesc 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;
    
    /* Packets with the same group identifier can be plotted together on
     * the same graph */
    char* sGroup;
    
    void* pUser;  
} PktDesc;


PktDesc* new_PktDesc(void); 

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

void del_PktDesc(PktDesc* pThis);

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

int PktDesc_getId(const PktDesc* pThis);

const char* PktDesc_getGroup(const PktDesc* pThis);

void PktDesc_setGroup(PktDesc* pThis, const char* sGroup);


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);


DasErrCode 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);


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

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

PlaneDesc* PktDesc_getPlaneByType(
   PktDesc* pThis, plane_type_t ptype, int iRelIndex);

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

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

PlaneDesc* PktDesc_getXPlane(PktDesc* pThis);

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

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

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

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

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

#ifdef __cplusplus
}
#endif

#endif /* _das_packet_h_ */