datum.h

Go to the documentation of this file.

/* Copyright (C) 2017 Chris Piker <chris-piker@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 _das_datum_h_
#define _das_datum_h_
 
#include <das2/value.h>
#include <das2/units.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define DATUM_BUF_SZ 32 // big enough to hold a das_vector and das_time
   
typedef struct datum_t {
   ubyte bytes[DATUM_BUF_SZ]; /* 32 bytes of space */
   das_val_type vt;
   uint32_t vsize;
   das_units units;
} das_datum;
 
#define das_datum_valid(p) ((p)->vsize > 0)
 
ptrdiff_t das_datum_shape0(const das_datum* pThis);
 
DAS_API bool das_datum_fromStr(das_datum* pThis, const char* sStr);
 
DAS_API bool das_datum_fromDbl(das_datum* pThis, double value, das_units units);
 
DAS_API bool das_datum_wrapStr(das_datum* pTHis, const char* sStr, das_units units);
 
 
DAS_API bool das_datum_byteSeq(
   das_datum* pThis, das_byteseq seq, das_units units
);
 
DAS_API char* das_datum_toStr(
   const das_datum* pThis, char* sStr, size_t uLen, int nFracDigits
);
 
DAS_API char* das_datum_toStrValOnly(
   const das_datum* pThis, char* sStr, size_t uLen, int nFracDigits
);
 
 
DAS_API double das_datum_toDbl(const das_datum* pThis);
 
 
DAS_API bool das_datum_toEpoch(
   const das_datum* pThis, das_units epoch, double* pResult
);
 
#define das_datum_asStr(dm) *((char**)&dm)
 
#ifdef __cplusplus
}
#endif
 
#endif   /* _das_datum_h_ */