base/libs/timeio/timeio.h

/*
 *  timeio.h                            ~CM)/include
 *
 *  Defines and declarations for date/time parsers sscan_time(), sprint_time(),
 *    and related functions in SOI CM libast.
 *  Additional information is in the following man pages:
 *      sscan_time (3), sprint_time (3)
 *
 *  Responsible:  Rick Bogart               RBogart@spd.aas.org
 *
 *  Bugs:
 *    The function utc_adjustment is undocumented, and should probably not be
 *  exposed as an extern, or possibly eliminated entirely
 *    The TIME typedef declaration conflicts with the same typedef in the old
 *      wso /usr/local functions, and the meaning is different; concurrent use
 *      of both libraries should be avoided
 *
 *  Revision history is at the end of the file.
 */
#ifndef TIMECNVRT_INCL
/****************************************************************************/
/**************************  INCLUDE STATEMENTS  ****************************/
/****************************************************************************/

#include <sys/types.h>
#include <time.h>

/****************************************************************************/
/****************************  DEFINE STATEMENTS  ***************************/
/****************************************************************************/

#define TIMECNVRT_INCL   1

/****************************************************************************/
/*******************************  TYPEDEFS  *********************************/
/****************************************************************************/

typedef double TIME;

/****************************************************************************/
/****************************  MACRO DEFINITIONS  ***************************/
/****************************************************************************/

#define sprint_at(A, B) (sprint_time (A, B, "TAI", 0))

#define sprint_dt(A, B) (sprint_time (A, B, "TDT", 0))

#define sprint_ut(A, B) (sprint_time (A, B, "UT", 0))
#define CURRENT_SYSTEM_TIME (time (NULL) + UNIX_EPOCH)

#define JULIAN_DAY_ZERO (sscan_time ("JD_0.0"))
#define SOHO_EPOCH (sscan_time ("1958.01.01_00:00:00_TAI"))
#define UNIX_EPOCH (sscan_time ("1970.01.01_00:00:00_UTC"))
#define SOHO_LAUNCH (sscan_time ("1995.12.02_08:08:00_UT"))
#define MDI_FIRST_LIGHT (sscan_time ("1995.12.19_17:49:00_UT"))
#define SOI_START_LOGS (sscan_time ("1996.01.01_00:00:00_TAI"))
#define MISSION_EPOCH (sscan_time ("1993.01.01_00:00:00_TAI"))

extern const int kTIMEIO_MaxTimeEpochStr;
#define DRMS_EPOCH_S "1977.01.01_00:00:00_TAI"
#define DRMS_EPOCH_F (sscan_time(DRMS_EPOCH_S))
#define DRMS_EPOCH (0.000)
#define MDI_EPOCH_S "1993.01.01_00:00:00_TAI"
#define MDI_EPOCH_F (sscan_time(MDI_EPOCH_S))
#define MDI_EPOCH (504921600.000)
#define WSO_EPOCH_S "1601.01.01_00:00:00_UT"
#define WSO_EPOCH_F (sscan_time(WSO_EPOCH_S))
#define WSO_EPOCH (-11865398400.000)
#define TAI_EPOCH_S "1958.01.01_00:00:00_TAI"
#define TAI_EPOCH_F (sscan_time(TAI_EPOCH_S))
#define TAI_EPOCH (-599616000.000)
#define MJD_EPOCH_S "1858.11.17_00:00:00_UT"
#define MJD_EPOCH_F (sscan_time(MJD_EPOCH_S))
#define MJD_EPOCH (-3727641600.000)

/****************************************************************************/
/***************************  FUNCTION PROTOTYPES  **************************/
/****************************************************************************/

                      /*  source file: timeio/timeio.c  */
extern TIME sscan_time (char *s);

int sscan_time_ext(char *s, TIME *out);

extern void sprint_time (char *s, TIME t, char *zone, int precision);

extern double tai_adjustment (TIME t, char *zone);

extern double zone_adjustment (char *zone);

int zone_isvalid (char *zone);

extern int time_is_invalid (TIME t);

int parsetimestr (const char *timestr,
                  int **year,
                  int **month,
                  int **dofm,
                  int **dofy,
                  int **hour,
                  int **minute,
                  double **second,
                  char **zone,
                  double **juliday,
                  int *consumedout);

int parse_zone(const char *zonestr, char *out, int size);
#endif
/*
 *  Revision History
 *  V 1.0  07.05.04 Rick Bogart     created this file, based on previous
 *      file soi_time.h, renamed, with minor modifications as follows:
 *  changed inclusion define from SOI_TIME_INCL to TIMECNVRT_INCL
 *  remove SOI_TIME_VERSION_NUM definition
 *  removed conditional on TIME typedef
 *  removed extern declaration of utc_adjustment()
 *  updated comments
 *  07.05.25    R Bogart    added prototype for time_is_invalid
 */

---