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 das2C, the Core Das C Library.
 * 
 * Das2C 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.
 *
 * Das2C 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 Das2C; if not, see <http://www.gnu.org/licenses/>. 
 */
 
 
#ifndef _das_packet_h_
#define _das_packet_h_
 
#include <das3/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;
 
 
DAS_API PktDesc* new_PktDesc(void);
 
DAS_API PktDesc* copy_PktDesc(const PktDesc* pOther);
 
DAS_API PktDesc* new_PktDesc_xml(DasBuf* pBuf, DasDesc* pParent, int nPktId);
 
DAS_API void del_PktDesc(PktDesc* pThis);
 
DAS_API bool PktDesc_equalFormat(const PktDesc* pPd1, const PktDesc* pPd2);
 
DAS_API int PktDesc_getId(const PktDesc* pThis);
 
DAS_API const char* PktDesc_getGroup(const PktDesc* pThis);
 
DAS_API void PktDesc_setGroup(PktDesc* pThis, const char* sGroup);
 
 
DAS_API size_t PktDesc_recBytes(const PktDesc* pThis);
 
 
DAS_API size_t PktDesc_getNPlanes(const PktDesc* pThis);
 
DAS_API size_t PktDesc_getNPlanesOfType(const PktDesc* pThis, plane_type_t pt);
 
DAS_API int PktDesc_addPlane(PktDesc* pThis, PlaneDesc* pPlane);
 
 
DAS_API DasErrCode PktDesc_copyPlanes(PktDesc* pThis,  const PktDesc* pOther);
 
DAS_API bool PktDesc_validate(PktDesc* pThis );
 
DAS_API plane_type_t PktDesc_getPlaneType(const PktDesc* pThis, int iPlane);
 
 
DAS_API PlaneDesc* PktDesc_getPlane(PktDesc* pThis, int iplane);
 
 
DAS_API PlaneDesc* PktDesc_replaceAt(PktDesc* pThis, int iPlane, PlaneDesc* pNew);
 
 
DAS_API int PktDesc_getPlaneIdx(PktDesc* pThis, PlaneDesc* pPlane);
 
DAS_API PlaneDesc* PktDesc_getPlaneByName(PktDesc* pThis, const char* name);
 
DAS_API PlaneDesc* PktDesc_getPlaneByType(
   PktDesc* pThis, plane_type_t ptype, int iRelIndex);
 
DAS_API int PktDesc_getPlaneIdxByType(
   const PktDesc* pThis, plane_type_t ptype, int iRelIndex
);
 
DAS_API int PktDesc_getPlaneIdxByName(
   PktDesc* pThis, const char* name, plane_type_t planeType
);
 
DAS_API PlaneDesc* PktDesc_getXPlane(PktDesc* pThis);
 
DAS_API DasErrCode PktDesc_encode(const PktDesc* pThis, DasBuf* pBuf);
 
DAS_API DasErrCode PktDesc_encodeData(const PktDesc* pThis, DasBuf* pBuf);
 
DAS_API DasErrCode PktDesc_decodeData(PktDesc* pThis, DasBuf* pBuf);
 
DAS_API DasErrCode PktDesc_setValue(
   PktDesc* pThis, size_t uPlane, size_t uItem, double val
);
 
DAS_API DasErrCode PktDesc_setValues(
   PktDesc* pThis, size_t uPlane, const double* pVals
);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _das_packet_h_ */