units.h

Go to the documentation of this file.

/* Copyright (C) 2004-2017 Chris Piker <chris-piker@uiowa.edu>
 *                         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 _das_units_h_
#define _das_units_h_
 
#include <stdbool.h>
#include <das3/time.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
DAS_API extern const char* UNIT_US2000; 
DAS_API extern const char* UNIT_MJ1958; 
DAS_API extern const char* UNIT_T2000;  
DAS_API extern const char* UNIT_T1970;  
DAS_API extern const char* UNIT_NS1970; 
DAS_API extern const char* UNIT_UTC;    
DAS_API extern const char* UNIT_TT2000; 
 
DAS_API extern const char* UNIT_ET2000;
 
/* Other common units */
DAS_API extern const char* UNIT_SECONDS; 
DAS_API extern const char* UNIT_HOURS;   
DAS_API extern const char* UNIT_DAYS;    
DAS_API extern const char* UNIT_MILLISECONDS; 
DAS_API extern const char* UNIT_MICROSECONDS; 
DAS_API extern const char* UNIT_NANOSECONDS;  
DAS_API extern const char* UNIT_HERTZ;   
DAS_API extern const char* UNIT_KILO_HERTZ;  
DAS_API extern const char* UNIT_MEGA_HERTZ;  
DAS_API extern const char* UNIT_GIGA_HERTZ;  
DAS_API extern const char* UNIT_E_SPECDENS;  
DAS_API extern const char* UNIT_B_SPECDENS;  
DAS_API extern const char* UNIT_NT;          
DAS_API extern const char* UNIT_NUMBER_DENS;  
DAS_API extern const char* UNIT_DB;  
DAS_API extern const char* UNIT_KM;  
DAS_API extern const char* UNIT_EV;  
DAS_API extern const char* UNIT_DEGREES;   
DAS_API extern const char* UNIT_DIMENSIONLESS;  
/* color:  Color should be handled as as vector, we don't have
 * support for vectors at this time.   Also a datatype of 
 * byte is needed for small values
 */
/* extern const char* UNIT_RGB; */
 
 
 
typedef const char* das_units;
 
DAS_API das_units Units_fromStr(const char* string);
 
 
DAS_API const char* Units_toStr(das_units unit);
 
 
DAS_API char* Units_toLabel(das_units unit, char* sBuf, size_t uLen);
 
 
DAS_API das_units Units_invert(das_units unit);
 
 
DAS_API das_units Units_multiply(das_units ut1, das_units ut2);
 
DAS_API das_units Units_divide(das_units a, das_units b);
 
 
DAS_API das_units Units_power(das_units unit, int power);
 
 
DAS_API das_units Units_root(das_units unit, int root );
 
 
DAS_API das_units Units_interval(das_units unit);
 
 
DAS_API das_units Units_reduce(das_units orig, double* pFactor);
 
DAS_API bool Units_canConvert(das_units fromUnits , das_units toUnits);
 
 
DAS_API double Units_convertTo( das_units toUnits, double rVal, das_units fromUnits );
 
 
DAS_API bool Units_haveCalRep(das_units unit);
 
 
DAS_API DasErrCode Units_convertToDt(das_time* pDt, double value, das_units epoch_units);
 
DAS_API double Units_convertFromDt(das_units epoch_units, const das_time* pDt);
 
DAS_API double Units_secondsSinceMidnight( double rVal, das_units epoch_units );
 
 
/* Get the Julian day for the Datum (double,unit) */
DAS_API int Units_getJulianDay( double timeDouble, das_units epoch_units );
 
DAS_API bool Units_canMerge(das_units left, int op, das_units right);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _das_units_h_ */