Element getters

Functions
int	sct_get_jd (const sct_time_ptr pElement, double *pJd)
int	sct_get_mjd (const sct_time_ptr pElement, double *pMjd)
int	sct_get_mjd2000 (const sct_time_ptr pElement, double *pMjd2000)
int	sct_get_YMDHMSF (const sct_time_ptr pElement, unsigned int *pYear, unsigned int *pMonth, unsigned int *pDay, unsigned int *pHour, unsigned int *pMinute, unsigned int *pSecond, u_int64_t *pFemtosecond)
int	sct_get_delta_secs (const sct_time_ptr pDelta, double *pSecs)
int	sct_print (const sct_time_ptr pElement)

---

Detailed Description

This group of functions contain the whole list of methods which can be used to get the values of sct_time elements.

---

Function Documentation

int sct_get_delta_secs	(	const sct_time_ptr	pDelta,
		double *	pSecs
	)

Function to get the total number of seconds in a sct_time delta element

Parameters:

	pDelta	(IN) Pointer to a sct_time element
	pSecs	(OUT) Pointer to the output double element (seconds scale)

Returns:

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

Definition at line 460 of file sct_io.c.

References _sct_time_base::days, _sct_time_base::fsecs, SCT_RET_INVALID_PTR, SCT_RET_NOT_INITIALISED, SCT_RET_OK, SCT_SECS_IN_DAY, SCT_STATUS_DELTA, _sct_time_base::secs, and _sct_time_base::status.

Referenced by main(), and sct_compare().

int sct_get_jd	(	const sct_time_ptr	pElement,
		double *	pJd
	)

Function to get the epoch in Julian Date format from a sct_time element

Parameters:

	pElement	(IN) Pointer to a sct_time element
	pJd	(OUT) Pointer to the double which will contain the output JD epoch

Returns:

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

Definition at line 300 of file sct_io.c.

References sct_get_mjd2000(), SCT_JD_TO_J2000, and SCT_RET_OK.

Referenced by _sct_get_leapseconds_from_epoch(), and main().

Here is the call graph for this function:

int sct_get_mjd	(	const sct_time_ptr	pElement,
		double *	pMjd
	)

Function to get the epoch in Modified Julian Date format from a sct_time element

Parameters:

	pElement	(IN) Pointer to a sct_time element
	pMjd	(OUT) Pointer to the double which will contain the output MJD epoch

Returns:

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

Definition at line 319 of file sct_io.c.

References sct_get_mjd2000(), SCT_MJD_TO_J2000, and SCT_RET_OK.

Referenced by _sct_get_leapseconds_from_epoch(), and main().

Here is the call graph for this function:

int sct_get_mjd2000	(	const sct_time_ptr	pElement,
		double *	pMjd2000
	)

Function to get the epoch in Modified Julian Date 2000 format from a sct_time element

Parameters:

	pElement	(IN) Pointer to a sct_time element
	pMjd2000	(OUT) Pointer to the double which will contain the output MJD2000 epoch

Returns:

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

Definition at line 338 of file sct_io.c.

References _sct_time_base::days, _sct_time_base::fsecs, SCT_RET_NOT_INITIALISED, SCT_RET_OK, SCT_SECS_IN_DAY, SCT_STATUS_OK, _sct_time_base::secs, and _sct_time_base::status.

Referenced by main(), sct_get_jd(), and sct_get_mjd().

int sct_get_YMDHMSF	(	const sct_time_ptr	pElement,
		unsigned int *	pYear,
		unsigned int *	pMonth,
		unsigned int *	pDay,
		unsigned int *	pHour,
		unsigned int *	pMinute,
		unsigned int *	pSecond,
		u_int64_t *	pFemtosecond
	)

Function to get the epoch in YMDHMSN format from a sct_time element

Parameters:

	pElement	(IN) Pointer to a sct_time element
	pYear	(OUT) Year
	pMonth	(OUT) Month (1-12)
	pDay	(OUT) Day (1-31)
	pHour	(OUT) Hours (0-23)
	pMinute	(OUT) Minutes (0-59)
	pSecond	(OUT) Seconds (0-59)
	pFemtosecond	(OUT) Femtoseconds

Returns:

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

Definition at line 362 of file sct_io.c.

References _sct_time_base::days, _sct_time_base::fsecs, SCT_JD_TO_J2000, SCT_RET_INVALID_PTR, SCT_RET_OK, and _sct_time_base::secs.

Referenced by main().

int sct_print

(

const sct_time_ptr

pElement

)

Function to print to stdout the contents of a sct_time element

Parameters:

pElement

(IN) Pointer to a sct_time element

Returns:

SCT_RET return value.

Definition at line 500 of file sct_io.c.

References _sct_time_base::accuracy, _sct_time_base::days, _sct_time_base::fsecs, SCT_RET_OK, SCT_STATUS_DELTA, SCT_STATUS_NOT_INITIALISED, SCT_STATUS_OK, _sct_time_base::secs, and _sct_time_base::status.

Referenced by main().

---