Time scale management functions

Functions
SCT_TIMESCALE	sct_get_timescale (const sct_time_ptr pElem)
SCT_RET	sct_set_timescale (sct_time_ptr pElem, SCT_TIMESCALE timescale)
SCT_RET	sct_from_TAI_to_UTC (sct_time_ptr pElem)
SCT_RET	sct_from_TAI_to_GPS (sct_time_ptr pElem)
SCT_RET	sct_from_TAI_to_UT (sct_time_ptr pElem)
SCT_RET	sct_from_UTC_to_TAI (sct_time_ptr pElem)
SCT_RET	sct_from_UTC_to_GPS (sct_time_ptr pElem)
SCT_RET	sct_from_UTC_to_UT (sct_time_ptr pElem)
SCT_RET	sct_from_GPS_to_TAI (sct_time_ptr pElem)
SCT_RET	sct_from_GPS_to_UTC (sct_time_ptr pElem)
SCT_RET	sct_from_GPS_to_UT (sct_time_ptr pElem)
SCT_RET	sct_from_UT_to_TAI (sct_time_ptr pElem)
SCT_RET	sct_from_UT_to_GPS (sct_time_ptr pElem)
SCT_RET	sct_from_UT_to_UTC (sct_time_ptr pElem)

---

Detailed Description

This group of functions contain the whole list of methods which can be used to manage the different time scales that are available in the scitime library

---

Function Documentation

SCT_RET sct_from_GPS_to_TAI

(

sct_time_ptr

pElem

)

Function to convert time scale from GPS to TAI

Parameters:

pElem

(OUT) Pointer to the sct_time element.

Returns:

SCT_RET return value. If SCT_RET_OK is not returned, the element might not be correctly set.

Definition at line 244 of file sct_timescales.c.

References sct_add_deltaDSF(), SCT_GPS_TAI_LEAPSECOND, SCT_RET_OK, SCT_TIMESCALE_GPS, SCT_TIMESCALE_TAI, and _sct_time_base::timescale.

Here is the call graph for this function:

SCT_RET sct_from_GPS_to_UT

(

sct_time_ptr

pElem

)

Function to convert time scale from GPS to UT

Parameters:

pElem

(OUT) Pointer to the sct_time element.

Returns:

SCT_RET return value. If SCT_RET_OK is not returned, the element might not be correctly set.

Definition at line 303 of file sct_timescales.c.

References SCT_RET_OK, SCT_TIMESCALE_GPS, SCT_TIMESCALE_UT, and _sct_time_base::timescale.

SCT_RET sct_from_GPS_to_UTC

(

sct_time_ptr

pElem

)

Function to convert time scale from GPS to UTC

Parameters:

pElem

(OUT) Pointer to the sct_time element.

Returns:

SCT_RET return value. If SCT_RET_OK is not returned, the element might not be correctly set.

Definition at line 265 of file sct_timescales.c.

References _sct_get_leapseconds_from_epoch(), sct_add_delta(), sct_add_deltaDSF(), SCT_GPS_TAI_LEAPSECOND, SCT_RET_INVALID_LEAPSECONDS, SCT_RET_OK, sct_set_delta_secs(), SCT_TIMESCALE_GPS, SCT_TIMESCALE_UTC, and _sct_time_base::timescale.

Here is the call graph for this function:

SCT_RET sct_from_TAI_to_GPS

(

sct_time_ptr

pElem

)

Function to convert time scale from TAI to GPS

Parameters:

pElem

(OUT) Pointer to the sct_time element.

Returns:

SCT_RET return value. If SCT_RET_OK is not returned, the element might not be correctly set.

Definition at line 119 of file sct_timescales.c.

References sct_add_deltaDSF(), SCT_GPS_TAI_LEAPSECOND, SCT_RET_OK, SCT_TIMESCALE_GPS, SCT_TIMESCALE_TAI, and _sct_time_base::timescale.

Here is the call graph for this function:

SCT_RET sct_from_TAI_to_UT

(

sct_time_ptr

pElem

)

Function to convert time scale from TAI to UT

Parameters:

pElem

(OUT) Pointer to the sct_time element.

Returns:

SCT_RET return value. If SCT_RET_OK is not returned, the element might not be correctly set.

Definition at line 140 of file sct_timescales.c.

References SCT_RET_OK, SCT_TIMESCALE_TAI, SCT_TIMESCALE_UT, and _sct_time_base::timescale.

SCT_RET sct_from_TAI_to_UTC

(

sct_time_ptr

pElem

)

Function to convert time scale from TAI to UTC

Parameters:

pElem

(OUT) Pointer to the sct_time element.

Returns:

SCT_RET return value. If SCT_RET_OK is not returned, the element might not be correctly set.

Definition at line 86 of file sct_timescales.c.

References _sct_get_leapseconds_from_epoch(), sct_add_delta(), SCT_RET_INVALID_LEAPSECONDS, SCT_RET_OK, sct_set_delta_secs(), SCT_TIMESCALE_TAI, SCT_TIMESCALE_UTC, and _sct_time_base::timescale.

Referenced by main().

Here is the call graph for this function:

SCT_RET sct_from_UT_to_GPS

(

sct_time_ptr

pElem

)

Function to convert time scale from UT to GPS

Parameters:

pElem

(OUT) Pointer to the sct_time element.

Returns:

SCT_RET return value. If SCT_RET_OK is not returned, the element might not be correctly set.

Definition at line 337 of file sct_timescales.c.

References SCT_RET_OK, SCT_TIMESCALE_GPS, SCT_TIMESCALE_UT, and _sct_time_base::timescale.

SCT_RET sct_from_UT_to_TAI

(

sct_time_ptr

pElem

)

Function to convert time scale from UT to TAI

Parameters:

pElem

(OUT) Pointer to the sct_time element.

Returns:

SCT_RET return value. If SCT_RET_OK is not returned, the element might not be correctly set.

Definition at line 320 of file sct_timescales.c.

References SCT_RET_OK, SCT_TIMESCALE_TAI, SCT_TIMESCALE_UT, and _sct_time_base::timescale.

SCT_RET sct_from_UT_to_UTC

(

sct_time_ptr

pElem

)

Function to convert time scale from UT to UTC

Parameters:

pElem

(OUT) Pointer to the sct_time element.

Returns:

SCT_RET return value. If SCT_RET_OK is not returned, the element might not be correctly set.

Definition at line 354 of file sct_timescales.c.

References SCT_RET_OK, SCT_TIMESCALE_UT, SCT_TIMESCALE_UTC, and _sct_time_base::timescale.

SCT_RET sct_from_UTC_to_GPS

(

sct_time_ptr

pElem

)

Function to convert time scale from UTC to GPS

Parameters:

pElem

(OUT) Pointer to the sct_time element.

Returns:

SCT_RET return value. If SCT_RET_OK is not returned, the element might not be correctly set.

Definition at line 190 of file sct_timescales.c.

References _sct_get_leapseconds_from_epoch(), sct_add_delta(), sct_add_deltaDSF(), SCT_GPS_TAI_LEAPSECOND, SCT_RET_INVALID_LEAPSECONDS, SCT_RET_OK, sct_set_delta_secs(), SCT_TIMESCALE_GPS, SCT_TIMESCALE_UTC, and _sct_time_base::timescale.

Here is the call graph for this function:

SCT_RET sct_from_UTC_to_TAI

(

sct_time_ptr

pElem

)

Function to convert time scale from UTC to TAI

Parameters:

pElem

(OUT) Pointer to the sct_time element.

Returns:

SCT_RET return value. If SCT_RET_OK is not returned, the element might not be correctly set.

Definition at line 157 of file sct_timescales.c.

References _sct_get_leapseconds_from_epoch(), sct_add_delta(), SCT_RET_INVALID_LEAPSECONDS, SCT_RET_OK, sct_set_delta_secs(), SCT_TIMESCALE_TAI, SCT_TIMESCALE_UTC, and _sct_time_base::timescale.

Here is the call graph for this function:

SCT_RET sct_from_UTC_to_UT

(

sct_time_ptr

pElem

)

Function to convert time scale from UTC to UT

Parameters:

pElem

(OUT) Pointer to the sct_time element.

Returns:

SCT_RET return value. If SCT_RET_OK is not returned, the element might not be correctly set.

Definition at line 227 of file sct_timescales.c.

References SCT_RET_OK, SCT_TIMESCALE_UT, SCT_TIMESCALE_UTC, and _sct_time_base::timescale.

SCT_TIMESCALE sct_get_timescale

(

const sct_time_ptr

pElem

)

Function to get the time scale of a given element

Parameters:

pElem

(OUT) Pointer to the sct_time element.

Returns:

SCT_TIMESCALE return value. Time scale of the element.

Definition at line 75 of file sct_timescales.c.

References _sct_time_base::timescale.

SCT_RET sct_set_timescale	(	sct_time_ptr	pElem,
		SCT_TIMESCALE	timescale
	)

Function to set the time scale of a given element

Parameters:

pElem

(OUT) Pointer to the sct_time element.

Returns:

SCT_TIMESCALE return value. Time scale of the element.

Definition at line 80 of file sct_timescales.c.

References SCT_RET_OK, and _sct_time_base::timescale.

---