| scty01 |
|
Table of contents
Procedure
SCTY01 ( SCLK type, using type 1 SCLK database )
ENTRY SCTY01 ( SC, CLKTYP )
Abstract
Return the type of a specified clock. The clock need not be
type 1.
Required_Reading
SCLK
TIME
Keywords
CONVERSION
TIME
Declarations
INTEGER SC
INTEGER CLKTYP
Brief_I/O
VARIABLE I/O DESCRIPTION
-------- --- --------------------------------------------------
SC I NAIF spacecraft clock ID code.
CLKTYP O NAIF spacecraft clock type.
Detailed_Input
SC is a NAIF ID code for a spacecraft clock.
Detailed_Output
CLKTYP is the integer spacecraft clock type. The type
need not be 1.
Parameters
None.
Exceptions
1) If a kernel variable identifying requested SCLK type is not
found, the error SPICE(KERNELVARNOTFOUND) is signaled.
2) If an error occurs in the course of updating the type 1 SCLK
database, the error is signaled by a routine in the call tree
of this routine.
3) It is not an error to request the type of a clock that is not
type 1.
Files
Appropriate kernels must be loaded by the calling program before
this routine is called.
The following data are required:
- An SCLK kernel providing data for the SCLK designated by
the input ID code SC.
In all cases, kernel data are normally loaded once per program
run, NOT every time this routine is called.
Particulars
SCLK "type" is a SPICE-specific concept. It indicates which
mechanism is used by SPICE for representing time as measured
by a specified clock, and for converting those time measurements
to standard time systems such as TDB.
This routine speeds up determination of a spacecraft clock's type
by querying the type 1 SCLK database for information about that
clock. If the clock is not found, the kernel pool is searched,
and if the clock is determined to be type 1, information about it
is stored in the type 1 database. If the clock is not type 1,
the type is returned, but the type 1 database is not modified.
This is the only entry point of SC01 for which it is valid to
supply the ID of a clock not of type 1.
Examples
See usage in the SPICELIB function SCTYPE.
Restrictions
1) This is essentially a SPICE-private routine. It should not
be called directly by user application code.
Literature_References
None.
Author_and_Institution
N.J. Bachman (JPL)
J. Diaz del Rio (ODC Space)
Version
SPICELIB Version 1.0.0, 01-DEC-2021 (NJB) (JDR)
New entry point.
|
Fri Dec 31 18:36:47 2021