descriptor.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 _descriptor_h_
#define _descriptor_h_
#include <stdbool.h>

#include <das2/units.h>
#include <das2/util.h>
#include <das2/buffer.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef enum DescriptorType {
   Unknown=0, PLANE=14001, PACKET=14002, STREAM=14003, VARIABLE=1500, 
   DATASET=1501
} desc_type_t;


typedef struct das_descriptor {
    desc_type_t type;
    char* properties[DAS_XML_MAXPROPS];
    const struct das_descriptor* parent;
    bool bLooseParsing;
} DasDesc;


void DasDesc_init(DasDesc* pThis, desc_type_t type);

/* Make an 'Unknown' type descriptor, incase you like using descriptor objects
 * to store things in your code, not used by the library 
 * @memberof DasDesc
 */
DasDesc* new_Descriptor(void);

void DasDesc_freeProps(DasDesc* pThis);

bool DasDesc_equals(const DasDesc* pOne, const DasDesc* pTwo);

const DasDesc* DasDesc_parent(DasDesc* pThis);

size_t DasDesc_length(const DasDesc* pThis);

const char* DasDesc_getNameByIdx(const DasDesc* pThis, size_t uIdx);

const char* DasDesc_getValByIdx(const DasDesc* pThis, size_t uIdx);

const char* DasDesc_getTypeByIdx(const DasDesc* pThis, size_t uIdx);

       
bool DasDesc_has(const DasDesc* pThis, const char* propertyName );

DasErrCode DasDesc_set(
   DasDesc* pThis, const char* sType, const char* sName, const char* sVal
);

const char* DasDesc_get(const DasDesc* pThis, const char * propertyName );


bool DasDesc_remove(DasDesc* pThis, const char* propretyName);

const char* DasDesc_getStr(const DasDesc* pThis, const char * propertyName );

DasErrCode DasDesc_setStr(
   DasDesc* pThis, const char* sName, const char* sVal
);

DasErrCode DasDesc_vSetStr(
   DasDesc* pThis, const char* sName, const char* sFmt, ...
);


double DasDesc_getDouble(const DasDesc* pThis, const char * propertyName);

DasErrCode DasDesc_setDouble(DasDesc* pThis, const char * propertyName, double value);

double DasDesc_getDatum(DasDesc* pThis, const char * sPropName, 
                        das_units units );

DasErrCode DasDesc_setDatum(
   DasDesc* pThis, const char* sName, double rVal, das_units units
);

double* DasDesc_getDoubleAry(DasDesc* pThis, const char * propertyName, 
                                int *nitems );

DasErrCode DasDesc_setDoubleArray(
   DasDesc* pThis, const char * propertyName, int nitems, double *value 
);

int DasDesc_getInt(const DasDesc* pThis, const char* propertyName);

DasErrCode DasDesc_setInt(DasDesc* pThis, const char * sName, int nVal);

bool DasDesc_getBool(DasDesc* pThis, const char* sPropName);

DasErrCode DasDesc_setBool(DasDesc* pThis, const char* sPropName, bool bVal);

DasErrCode DasDesc_setDatumRng(
DasDesc* pThis, const char * sName, double beg, double end, das_units units 
);

DasErrCode DasDesc_getStrRng(
   DasDesc* pThis, const char* sName, char* sMin, char* sMax, 
   das_units* pUnits, size_t uLen
);

DasErrCode DasDesc_setFloatAry(
   DasDesc* pThis, const char * propertyName, int nitems, float *value
);

void DasDesc_copyIn(DasDesc* pThis, const DasDesc* source );

DasErrCode DasDesc_encode(DasDesc* pThis, DasBuf* pBuf, const char* sIndent);
#ifdef __cplusplus
}
#endif

#endif /* _descriptor_h_ */