time.h

Go to the documentation of this file.

/* Copyright (C) 1997-2017 Larry Granroth <larry-granroth@uiowa.edu> 
 *                         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_time_h_
#define _das_time_h_
 
#include <das3/defs.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct das_time_t{
 
   int year; 
   
   int month; 
   
   int mday; 
   
   int yday; 
   
   int hour;
   
   int minute; 
   
   double second;
   
} das_time;
 
/* A version of above that would only use 16 bytes instead of 32 ....
   to enable and test later 
   
typedef struct das_time_t{
   / ** Calendar month number, 1 = January * /
   int8_t month; 
   
   / ** Calendar Day of month, starts at 1 * /
   int8_t mday; 
 
   / ** Hour of day, range is 0 to 23 * /
   int8_t hour;
   
   / ** Minute of the hour, range 0 to 59 * /
   int8_t minute; 
 
   / ** Calendar year number, cannot hold years before 1 AD * /
   int16_t year; 
 
   / ** Integer Day of year, Jan. 1st = 1.  
    *  This field is <b>output only</b> for most Das1 functions see the
    *  warning in dt_tnorm() * /
   int16_t yday; 
   
   / ** Second of the minute, range 0.0 to 60.0 - epsilon.  
    * Note, there is no provision for leap seconds in the library.  All
    * minutes are assumed to have 60 seconds.
    * /
   double second;
   
} das_time;
*/
 
#define DAS_TIME_NULL {0, 0, 0, 0, 0, 0, 0.0}
 
 
DAS_API void dt_null(das_time* pDt);
 
 
DAS_API bool dt_parsetime(das_time* pDt, const char* sTime);
 
 
DAS_API bool dt_now(das_time* pDt);
 
 
DAS_API void dt_from_1958(
   das_time* pDt, unsigned short int daysSince1958, unsigned int msOfDay
);
 
DAS_API int64_t dt_nano_1970(const das_time* dt);
 
DAS_API bool dt_in_range(
   const das_time* begin, const das_time* end, const das_time* test
);
 
DAS_API void dt_copy(das_time* pDest, const das_time* pSrc);
 
DAS_API void dt_set(
   das_time* pDt, int year, int month, int mday, int yday, int hour, 
   int minute, double second
);
 
DAS_API int dt_compare(const das_time* pA, const das_time* pB);
 
 
DAS_API double dt_diff(const das_time* pA, const das_time* pB);
 
DAS_API char* dt_isoc(const das_time* pDt, char* sBuf, size_t uLen, int nFracSec);
 
DAS_API char* dt_isod(const das_time* pDt, char* sBuf, size_t uLen, int nFracSec);
 
 
DAS_API char* dt_dual_str(const das_time* pDt, char* sBuf, size_t uLen, int nFracSec);
 
      
/* Julian Day at January 1, 1958, 12:00:00 UT */
#define EPOCH 2436205
 
              
DAS_API double dt_ttime(const das_time* dt);
 
DAS_API void dt_emitt(das_time* pDt, double tt);
 
/* Returned by dt_to_tt2k() for fields outside the TT2000 range or with
   negative members.  Also defined in tt2000.c, which is not installed; the
   two must stay the same value. */
#ifndef ILLEGAL_TT2000_VALUE
#define ILLEGAL_TT2000_VALUE (-9223372036854775805LL)
#endif
 
DAS_API int64_t dt_to_tt2k(const das_time* dt);
 
DAS_API void dt_from_tt2k(das_time* dt, int64_t nTime);
 
DAS_API DasErrCode tt2k_from_parts(
   int year, int month, int mday, int hour, int minute, int second,
   int32_t nanosec, int64_t* pTT
);
 
DAS_API void tt2k_to_parts(
   int64_t nTT, int* pYear, int* pMonth, int* pMday, int* pHour,
   int* pMinute, int* pSecond, int32_t* pNanosec
);
 
DAS_API void dt_tnorm(das_time* dt);
 
/* return Julian Day number given year, month, and day, not exported no purpose */
int jday (int year, int month, int day);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _das_time_h_ */