src/sct_common.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	_sct_time_base
Defines
#define	SCT_VERSION   "0.0.1"
	Version of this SCITIME library.
#define	SCT_SECS_IN_DAY   86400L
	Maximum number of seconds in a day.
#define	SCT_FSECS_IN_DAY   864E17L
	Maximum number of femtosecs in a day.
#define	SCT_FSECS_IN_SEC   1E15
	Number of femptosecs in a sec.
#define	SCT_MJD_TO_J2000   51544.0
	Offset from Modified Julian Date to Modified Julian Date 2000 format.
#define	SCT_JD_TO_J2000   2451544.5
	Offset from Julian Date to Modified Julian Date 2000 format.
#define	SCT_GPS_TAI_LEAPSECOND   19
	Difference between TAI and GPS time scales (TAI-GPS), in seconds.
Typedefs
typedef _sct_time_base	sct_time
typedef sct_time *	sct_time_ptr
	Pointer to a sct_time structure.
Enumerations
enum	SCT_STATUS { SCT_STATUS_NOT_INITIALISED = 0, SCT_STATUS_OK = 1, SCT_STATUS_DELTA = 2 }
enum	SCT_ACCURACY {   SCT_ACCURACY_FEMTOSECS = -15, SCT_ACCURACY_10FEMTOSECS = -14, SCT_ACCURACY_100FEMTOSECS = -13, SCT_ACCURACY_PICOSECS = -12,   SCT_ACCURACY_10PICOSECS = -11, SCT_ACCURACY_100PICOSECS = -10, SCT_ACCURACY_NANOSECS = -9, SCT_ACCURACY_10NANOSECS = -8,   SCT_ACCURACY_100NANOSECS = -7, SCT_ACCURACY_MICROSECS = -6, SCT_ACCURACY_10MICROSECS = -5, SCT_ACCURACY_100MICROSECS = -4,   SCT_ACCURACY_MILISECS = -3, SCT_ACCURACY_CENTISECS = -2, SCT_ACCURACY_DECISECS = -1, SCT_ACCURACY_SECS = 0,   SCT_ACCURACY_DECASECS = 1, SCT_ACCURACY_HECTOSECS = 2, SCT_ACCURACY_KILOSECS = 3, SCT_ACCURACY_MEGASECS = 4,   SCT_ACCURACY_DAYS = 5 }
enum	SCT_TIMESCALE { SCT_TIMESCALE_TAI = 0, SCT_TIMESCALE_UTC = 1, SCT_TIMESCALE_GPS = 2, SCT_TIMESCALE_UT = 3 }
enum	SCT_RET {   SCT_RET_INVALID_LEAPSECONDS = -4, SCT_RET_INVALID_NUMBER = -3, SCT_RET_INVALID_PTR = -2, SCT_RET_NOT_INITIALISED = -1,   SCT_RET_OK = 0 }

---

Define Documentation

#define SCT_FSECS_IN_DAY   864E17L

Maximum number of femtosecs in a day.

Definition at line 31 of file sct_common.h.

#define SCT_FSECS_IN_SEC   1E15

Number of femptosecs in a sec.

Definition at line 34 of file sct_common.h.

Referenced by sct_add_delta(), sct_diff(), sct_set_delta_secs(), and sct_set_mjd2000_acc().

#define SCT_GPS_TAI_LEAPSECOND   19

Difference between TAI and GPS time scales (TAI-GPS), in seconds.

Definition at line 43 of file sct_common.h.

Referenced by sct_from_GPS_to_TAI(), sct_from_GPS_to_UTC(), sct_from_TAI_to_GPS(), and sct_from_UTC_to_GPS().

#define SCT_JD_TO_J2000   2451544.5

Offset from Julian Date to Modified Julian Date 2000 format.

Definition at line 40 of file sct_common.h.

Referenced by sct_get_jd(), sct_get_YMDHMSF(), sct_set_jd(), and sct_set_jd_acc().

#define SCT_MJD_TO_J2000   51544.0

Offset from Modified Julian Date to Modified Julian Date 2000 format.

Definition at line 37 of file sct_common.h.

Referenced by sct_get_mjd(), sct_set_mjd(), and sct_set_mjd_acc().

#define SCT_SECS_IN_DAY   86400L

Maximum number of seconds in a day.

Definition at line 28 of file sct_common.h.

Referenced by sct_add_delta(), sct_diff(), sct_get_delta_secs(), sct_get_mjd2000(), and sct_set_delta_secs().

#define SCT_VERSION   "0.0.1"

Version of this SCITIME library.

Definition at line 25 of file sct_common.h.

---

Typedef Documentation

typedef struct _sct_time_base sct_time

This structure handles the minimum data object in the scitime library.

typedef sct_time* sct_time_ptr

Pointer to a sct_time structure.

Definition at line 119 of file sct_common.h.

---

Enumeration Type Documentation

enum SCT_ACCURACY

Enumerator:

SCT_ACCURACY_FEMTOSECS	Accuracy up to 0.000000000000001 secs.
SCT_ACCURACY_10FEMTOSECS	Accuracy up to 0.00000000000001 secs.
SCT_ACCURACY_100FEMTOSECS	Accuracy up to 0.0000000000001 secs.
SCT_ACCURACY_PICOSECS	Accuracy up to 0.000000000001 secs.
SCT_ACCURACY_10PICOSECS	Accuracy up to 0.00000000001 secs.
SCT_ACCURACY_100PICOSECS	Accuracy up to 0.0000000001 secs.
SCT_ACCURACY_NANOSECS	Accuracy up to 0.000000001 secs.
SCT_ACCURACY_10NANOSECS	Accuracy up to 0.00000001 secs.
SCT_ACCURACY_100NANOSECS	Accuracy up to 0.0000001 secs.
SCT_ACCURACY_MICROSECS	Accuracy up to 0.000001 secs.
SCT_ACCURACY_10MICROSECS	Accuracy up to 0.00001 secs.
SCT_ACCURACY_100MICROSECS	Accuracy up to 0.0001 secs.
SCT_ACCURACY_MILISECS	Accuracy up to 0.001 secs.
SCT_ACCURACY_CENTISECS	Accuracy up to 0.01 secs.
SCT_ACCURACY_DECISECS	Accuracy up to 0.1 secs.
SCT_ACCURACY_SECS	Accuracy up to 1 secs.
SCT_ACCURACY_DECASECS	Accuracy up to 10 secs.
SCT_ACCURACY_HECTOSECS	Accuracy up to 100 secs.
SCT_ACCURACY_KILOSECS	Accuracy up to 1000 secs.
SCT_ACCURACY_MEGASECS	Accuracy up to 10000 secs.
SCT_ACCURACY_DAYS	Accuracy up to 86400 secs.

Definition at line 57 of file sct_common.h.

enum SCT_RET

This enumeration shows the full list of available return values for the whole scitime library.

Enumerator:

SCT_RET_INVALID_LEAPSECONDS	Invalid number of leapseconds.
SCT_RET_INVALID_NUMBER	Invalid number was received.
SCT_RET_INVALID_PTR	Invalid pointer was received.
SCT_RET_NOT_INITIALISED	Element to use isn't initialised.
SCT_RET_OK	Ok.

Definition at line 98 of file sct_common.h.

enum SCT_STATUS

This enumeration shows the full list of available status values for the sct_time elements.

Enumerator:

SCT_STATUS_NOT_INITIALISED	Element wasn't initialised.
SCT_STATUS_OK	Status ok, epoch element.
SCT_STATUS_DELTA	Status ok, delta element.

Definition at line 50 of file sct_common.h.

enum SCT_TIMESCALE

This enumeration shows the full list of available time scales within the scitime library.

Enumerator:

SCT_TIMESCALE_TAI	Time scale is TAI (Default).
SCT_TIMESCALE_UTC	Time scale is UTC.
SCT_TIMESCALE_GPS	Time scale is GPS time scale.
SCT_TIMESCALE_UT	Time scale is Universal Time.

Definition at line 86 of file sct_common.h.

---