Element setters


Functions

int sct_set_jd (sct_time_ptr pElement, const double jd)
int sct_set_jd_acc (sct_time_ptr pElement, const double jd, const SCT_ACCURACY accuracy)
int sct_set_mjd (sct_time_ptr pElement, const double mjd)
int sct_set_mjd_acc (sct_time_ptr pElement, const double mjd, const SCT_ACCURACY accuracy)
int sct_set_mjd2000 (sct_time_ptr pElement, const double mjd2000)
int sct_set_mjd2000_acc (sct_time_ptr pElement, const double mjd2000, const SCT_ACCURACY accuracy)
int sct_set_YMDHMSF (sct_time_ptr pElement, const unsigned int year, const unsigned int month, const unsigned int day, const unsigned int hour, const unsigned int minute, const unsigned int second, const u_int64_t femtosecond)
int sct_copy (sct_time_ptr pDest, const sct_time_ptr pSource)
int sct_set_delta_secs (sct_time_ptr pDelta, const double secs)
int sct_clear (sct_time_ptr pElement)

Detailed Description

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

Function Documentation

int sct_clear ( sct_time_ptr  pElement  ) 

Function to clear the contents of a sct_time element

Parameters:
pElement (IN) Pointer to a sct_time element
Returns:
SCT_RET return value.

Definition at line 275 of file sct_io.c.

References _sct_time_base::accuracy, _sct_time_base::days, _sct_time_base::fsecs, SCT_ACCURACY_DAYS, SCT_RET_INVALID_PTR, SCT_RET_OK, SCT_STATUS_NOT_INITIALISED, _sct_time_base::secs, and _sct_time_base::status.

int sct_copy ( sct_time_ptr  pDest,
const sct_time_ptr  pSource 
)

Function to set copy the contents of a sct_time element into another sct_time element

Parameters:
pDest (OUT) Pointer to the output sct_time element
pSource (IN) Pointer to the input sct_time element
Returns:
SCT_RET return value. If SCT_RET_OK is not returned, the sct_time element might not be correctly set.

Definition at line 191 of file sct_io.c.

References SCT_RET_INVALID_PTR, SCT_RET_OK, SCT_STATUS_NOT_INITIALISED, and _sct_time_base::status.

Referenced by main(), and sct_add_delta().

int sct_set_delta_secs ( sct_time_ptr  pDelta,
const double  secs 
)

Function to set a sct_time delta element from a value in seconds

Parameters:
pDelta (OUT) Pointer to a sct_time element
secs (IN) Number of seconds
Returns:
SCT_RET return value. If SCT_RET_OK is not returned, the sct_time element might not be correctly set.

Definition at line 229 of file sct_io.c.

References _sct_time_base::accuracy, _sct_time_base::days, _sct_time_base::fsecs, SCT_FSECS_IN_SEC, sct_get_accuracy_from_secs(), SCT_RET_INVALID_PTR, SCT_RET_OK, SCT_SECS_IN_DAY, SCT_STATUS_DELTA, _sct_time_base::secs, and _sct_time_base::status.

Referenced by sct_from_GPS_to_UTC(), sct_from_TAI_to_UTC(), sct_from_UTC_to_GPS(), and sct_from_UTC_to_TAI().

Here is the call graph for this function:

int sct_set_jd ( sct_time_ptr  pElement,
const double  jd 
)

Function to set the sct_time element based on an input Julian Date epoch

Parameters:
pElement (OUT) Pointer to a sct_time element
jd (IN) Julian Date epoch
Returns:
SCT_RET return value. If SCT_RET_OK is not returned, the sct_time element might not be correctly set.

Definition at line 24 of file sct_io.c.

References sct_get_accuracy_from_jd(), SCT_JD_TO_J2000, and sct_set_mjd2000_acc().

Referenced by main(), and sct_set_YMDHMSF().

Here is the call graph for this function:

int sct_set_jd_acc ( sct_time_ptr  pElement,
const double  jd,
const SCT_ACCURACY  accuracy 
)

Function to set the sct_time element based on an input Julian Date epoch, explicitly setting the accuracy of the element

Parameters:
pElement (OUT) Pointer to a sct_time element
jd (IN) Julian Date epoch
accuracy (IN) Explicit accuracy
Returns:
SCT_RET return value. If SCT_RET_OK is not returned, the sct_time element might not be correctly set.

Definition at line 36 of file sct_io.c.

References SCT_JD_TO_J2000, and sct_set_mjd2000_acc().

Here is the call graph for this function:

int sct_set_mjd ( sct_time_ptr  pElement,
const double  mjd 
)

Function to set the sct_time element based on an input Modified Julian Date epoch

Parameters:
pElement (OUT) Pointer to a sct_time element
mjd (IN) Modified Julian Date epoch
Returns:
SCT_RET return value. If SCT_RET_OK is not returned, the sct_time element might not be correctly set.

Definition at line 46 of file sct_io.c.

References sct_get_accuracy_from_jd(), SCT_MJD_TO_J2000, and sct_set_mjd2000_acc().

Here is the call graph for this function:

int sct_set_mjd2000 ( sct_time_ptr  pElement,
const double  mjd2000 
)

Function to set the sct_time element based on an input Modified Julian Date 2000 epoch

Parameters:
pElement (OUT) Pointer to a sct_time element
mjd2000 (IN) Modified Julian Date 2000 epoch
Returns:
SCT_RET return value. If SCT_RET_OK is not returned, the sct_time element might not be correctly set.

Definition at line 68 of file sct_io.c.

References sct_get_accuracy_from_jd(), and sct_set_mjd2000_acc().

Referenced by main().

Here is the call graph for this function:

int sct_set_mjd2000_acc ( sct_time_ptr  pElement,
const double  mjd2000,
const SCT_ACCURACY  accuracy 
)

Function to set the sct_time element based on an input Modified Julian Date 2000 epoch, explicitly setting the accuracy of the element

Parameters:
pElement (OUT) Pointer to a sct_time element
mjd2000 (IN) Modified Julian Date 2000 epoch
accuracy (IN) Explicit accuracy
Returns:
SCT_RET return value. If SCT_RET_OK is not returned, the sct_time element might not be correctly set.

Definition at line 76 of file sct_io.c.

References _sct_time_base::accuracy, _sct_time_base::days, _sct_time_base::fsecs, SCT_FSECS_IN_SEC, SCT_RET_INVALID_PTR, SCT_RET_OK, SCT_STATUS_OK, _sct_time_base::secs, and _sct_time_base::status.

Referenced by sct_set_jd(), sct_set_jd_acc(), sct_set_mjd(), sct_set_mjd2000(), and sct_set_mjd_acc().

int sct_set_mjd_acc ( sct_time_ptr  pElement,
const double  mjd,
const SCT_ACCURACY  accuracy 
)

Function to set the sct_time element based on an input Modified Julian Date epoch, explicitly setting the accuracy of the element

Parameters:
pElement (OUT) Pointer to a sct_time element
mjd (IN) Modified Julian Date epoch
accuracy (IN) Explicit accuracy
Returns:
SCT_RET return value. If SCT_RET_OK is not returned, the sct_time element might not be correctly set.

Definition at line 58 of file sct_io.c.

References SCT_MJD_TO_J2000, and sct_set_mjd2000_acc().

Here is the call graph for this function:

int sct_set_YMDHMSF ( sct_time_ptr  pElement,
const unsigned int  year,
const unsigned int  month,
const unsigned int  day,
const unsigned int  hour,
const unsigned int  minute,
const unsigned int  second,
const u_int64_t  femtosecond 
)

Function to set the sct_time element based on an input YMDHMSN epoch

Parameters:
pElement (OUT) Pointer to a sct_time element
year (IN) Year
month (IN) Month (1-12)
day (IN) Day (1-31)
hour (IN) Hours (0-23)
minute (IN) Minutes (0-59)
second (IN) Seconds (0-59)
femtosecond (IN) 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 120 of file sct_io.c.

References _sct_time_base::accuracy, _sct_time_base::fsecs, SCT_ACCURACY_FEMTOSECS, SCT_RET_OK, sct_set_jd(), and _sct_time_base::secs.

Referenced by main().

Here is the call graph for this function:

Generated on Sun May 20 15:32:57 2007 for scitime by  doxygen 1.5.1