descriptor.h

Go to the documentation of this file.

/* Copyright (C) 2015-2024 Chris Piker <chris-piker@uiowa.edu>
 *               2004-2006 Jeremy Faden <jeremy-faden@uiowa.edu>
 *
 * This file is part of das2C, the Core Das2 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 _descriptor_h_
#define _descriptor_h_
#include <stdbool.h>
 
#include <das3/units.h>
#include <das3/util.h>
#include <das3/buffer.h>
#include <das3/property.h>
#include <das3/array.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum DescriptorType {
   UNK_DESC=0, STREAM=14000, 
   PLANE=14001, PACKET=14002, 
   DATASET=15000, PHYSDIM=15001, 
   VARIABLE=15002,
} desc_type_t;
 
 
DAS_API const char* das_desc_type_toStr(desc_type_t dt);
 
typedef struct das_descriptor {
    desc_type_t type;
 
   /* Properties will now be held in a das array so that they are in a continuous 
      block of memory.  Properties are laid out in memory as so:
 
      valid_code\0name\0type_code\0value\0
 
      this means that the array is RANK_2(0,4,*) and it will need 2 ancillary
      arrays of pointers to keep track of the boundaries.  Thus the number of
      independent allocations drops from:
 
         properties * N  so O(N)
      to:
         3               so O(1)
 
      and there is no upper limit to the number of properties (yay!)
   */
    //char* properties[400];
    DasAry properties;
 
    //Number of invalid properties (saved to make length cals faster)
    size_t uInvalid;
 
    struct das_descriptor* parent;
    bool bLooseParsing;
 
    /* This descriptor does NOT inherit properties: DasDesc_getProp stops
       its parent walk here even when parent is set. */
    bool bNoInherit;
} DasDesc;
 
#define DasDesc_type(P) ((P)->type)
 
/* @name DasDesc Functions
 * These work for any type of Descriptor, including ::PlaneDesc ,
 * ::PktDesc, ::DasStream, ::DasDs and ::DasDim.
 * To make your compiler happy you will need to cast Plane, Packet and
 * Stream Descriptor pointers to just the generic type of Descriptor pointer
 * when using these functions. For example:
 * @code
 * PktDesc* pPktDesc;
 * DasDesc_has((Descriptor*)pPktDesc, "SomePropName");
 * @endcode
 * @memberof DasDesc
 */
/* @{ */
 
 
 
DAS_API void DasDesc_init(DasDesc* pThis, desc_type_t type);
 
 
DAS_API int DasDesc_info(
   const DasDesc* pThis, char* sBuf, size_t uLen, const char* sIndent
);
 
/* Make an 'Unknown' type descriptor, incase you like using descriptor objects
 * to store things in your code, not used by the library 
 * @memberof DasDesc
 */
DAS_API DasDesc* new_Descriptor(void);
 
DAS_API void DasDesc_freeProps(DasDesc* pThis);
 
DAS_API void DasDesc_clearProps(DasDesc* pThis);
 
DAS_API bool DasDesc_equals(const DasDesc* pThis, const DasDesc* pOther);
 
DAS_API const DasDesc* DasDesc_parent(const DasDesc* pThis);
 
DAS_API size_t DasDesc_length(const DasDesc* pThis);
 
DAS_API const DasProp* DasDesc_getPropByIdx(const DasDesc* pThis, size_t uIdx);
 
DAS_API const char* DasDesc_getNameByIdx(const DasDesc* pThis, size_t uIdx);
 
DAS_API const char* DasDesc_getValByIdx(const DasDesc* pThis, size_t uIdx);
 
DAS_API const char* DasDesc_getTypeByIdx(const DasDesc* pThis, size_t uIdx);
 
 
DAS_API const char* DasDesc_getTypeByIdx3(const DasDesc* pThis, size_t uIdx);
 
DAS_API DasErrCode DasDesc_set(
   DasDesc* pThis, const char* sType, const char* sName, const char* sVal
);
 
DAS_API DasErrCode DasDesc_flexSet(
   DasDesc* pThis, const char* sType, ubyte uType, const char* sName,
   const char* sVal, char cSep, das_units units, int nStandard
);
 
DAS_API DasErrCode DasDesc_setProp(DasDesc* pThis, const DasProp* pProp);
 
DAS_API const char* DasDesc_getType(const DasDesc* pThis, const char* sName);
 
DAS_API das_units DasDesc_getUnits(const DasDesc* pThis, const char* sName);
 
DAS_API const char* DasDesc_get(const DasDesc* pThis, const char* sName);
 
DAS_API bool DasDesc_has(const DasDesc* pThis, const char* sName );
 
DAS_API bool DasDesc_hasLocal(const DasDesc* pThis, const char* sName);
 
 
DAS_API const DasProp* DasDesc_getProp(const DasDesc* pThis, const char* sName);
 
DAS_API const DasProp* DasDesc_getLocal(const DasDesc* pThis, const char* sName);
 
DAS_API bool DasDesc_remove(DasDesc* pThis, const char* sName);
 
DAS_API const char* DasDesc_getStr(const DasDesc* pThis, const char* sName);
 
 
DAS_API size_t DasDesc_getStrAry(
   DasDesc* pThis, const char* sName, char* pBuf, size_t uBufSz,
   char** psVals, size_t uMaxVals
);
 
DAS_API size_t DasDesc_getArray(
   DasDesc* pThis, const char* sName, char cSep,
   char* pBuf, size_t uBufSz, char** psVals, size_t uMaxVals
);
 
 
DAS_API DasErrCode DasDesc_setStr(
   DasDesc* pThis, const char* sName, const char* sVal
);
 
DAS_API DasErrCode DasDesc_vSetStr(
   DasDesc* pThis, const char* sName, const char* sFmt, ...
);
 
 
DAS_API double DasDesc_getDouble(const DasDesc* pThis, const char* sName);
 
DAS_API DasErrCode DasDesc_setDouble(
   DasDesc* pThis, const char* sName, double value
);
 
DAS_API double DasDesc_getDatum(
   DasDesc* pThis, const char* sName, das_units units 
);
 
DAS_API DasErrCode DasDesc_setDatum(
   DasDesc* pThis, const char* sName, double rVal, das_units units
);
 
DAS_API double* DasDesc_getDoubleAry(
   DasDesc* pThis, const char* sName, int* pNumItems
);
 
DAS_API DasErrCode DasDesc_setDoubleArray(
   DasDesc* pThis, const char* sName, int nItems, double* pValues
);
 
DAS_API int DasDesc_getInt(const DasDesc* pThis, const char* sName);
 
DAS_API DasErrCode DasDesc_setInt(DasDesc* pThis, const char* sName, int nVal);
 
DAS_API bool DasDesc_getBool(DasDesc* pThis, const char* sName);
 
DAS_API DasErrCode DasDesc_setBool(
   DasDesc* pThis, const char* sName, bool bVal
);
 
DAS_API DasErrCode DasDesc_setDatumRng(
   DasDesc* pThis, const char* sName, double beg, double end, das_units units
);
 
DAS_API DasErrCode DasDesc_getStrRng(
   DasDesc* pThis, const char* sName, char* sMin, char* sMax, 
   das_units* pUnits, size_t uLen
);
 
DAS_API DasErrCode DasDesc_setFloatAry(
   DasDesc* pThis, const char* sName, int nItems, float* pValues
);
 
DAS_API void DasDesc_copyIn(DasDesc* pThis, const DasDesc* pOther);
 
DAS_API DasErrCode DasDesc_encode2(
   DasDesc* pThis, DasBuf* pBuf, const char* sIndent
);
 
DAS_API DasErrCode DasDesc_encode3(
   DasDesc* pThis, DasBuf* pBuf, const char* sIndent
);
 
DAS_API DasErrCode DasDesc_encode3Bare(
   DasDesc* pThis, DasBuf* pBuf, const char* sIndent
);
 
DAS_API bool DasDesc_hasAnyProps(const DasDesc* pThis);
 
 
 
/* * @} */
 
#ifdef __cplusplus
}
#endif
 
#endif /* _descriptor_h_ */