Procedure

     SC01 ( Spacecraft clock, type 1 )

     SUBROUTINE SC01 ( SC,     CLKSTR, TICKS,  SCLKDP, ET,
    .                  NPARTN, PARBEG, PAREND, CLKTYP     )

Abstract

     Perform time conversions between different representations of
     type 1 spacecraft clock.

Required_Reading

     SCLK
     TIME

Keywords

     CONVERSION
     TIME

Declarations

     IMPLICIT NONE

     INCLUDE               'zzctr.inc'
     INCLUDE               'zzsc01.inc'

     INTEGER               SC
     CHARACTER*(*)         CLKSTR
     DOUBLE PRECISION      TICKS
     DOUBLE PRECISION      SCLKDP
     DOUBLE PRECISION      ET
     INTEGER               NPARTN
     DOUBLE PRECISION      PARBEG ( * )
     DOUBLE PRECISION      PAREND ( * )
     INTEGER               CLKTYP

Brief_I/O

     VARIABLE  I/O  ENTRY POINTS
     --------  ---  --------------------------------------------------
     SC         I   (All)
     CLKSTR    I-O  SCTK01, SCFM01
     TICKS     I-O  SCTK01, SCFM01
     SCLKDP    I-O  SCTE01, SCET01, SCEC01
     ET        I-O  SCTE01, SCET01, SCEC01
     NPARTN     O   SCPR01
     PARBEG     O   SCPR01
     PAREND     O   SCPR01
     CLKTYP     O   SCTY01
     MXCOEF     P   SCTE01, SCET01
     MXPART     P   (All)
     DELIMS     P   SCTK01, SCFM01
     MXNFLD     P   SCTK01, SCFM01
     DPLEN      P   SCTK01, SCFM01

Detailed_Input

     See the entry points SCTK01, SCFM01, SCET01, SCTE01, SCEC01.

Detailed_Output

     See the entry points SCTK01, SCFM01, SCET01, SCTE01, SCEC01.

Parameters

     MXCOEF   is the maximum number of coefficient sets in the
              array COEFFS that defines the mapping between
              encoded type 1 SCLK and a parallel time system,
              such as TDB or TDT. This array has dimension
              3 x MXCOEF. The value of MXCOEF may be increased
              as required.

     MXPART   is the maximum number of partitions for any type 1
              spacecraft clock. Type 1 SCLK kernels contain
              start and stop times for each partition. The value
              of MXPART may be increased as required.

     MXNFLD   is an upper bound on the number of components in
              the clock string.

     DPLEN    is an upper bound on the width of the individual
              components of the clock string.

     DELIMS   are the characters that are accepted delimiters of
              the clock components in the input SCLK string.

Exceptions

     1)  If SC01 is called directly, the error SPICE(BOGUSENTRY)
         is signaled.

     2)  See the entry points SCTK01, SCFM01, SCET01, SCTE01 for a
         description of the exceptions specific to those routines.

Files

     An SCLK kernel appropriate to the spacecraft clock identified
     by SC must be loaded at the time any entry point of this
     routine is called.

     If the SCLK kernel used with this routine does not map SCLK
     directly to barycentric dynamical time, a leapseconds kernel
     must be loaded at the time any entry point of this routine is
     called.

     Normally kernels are loaded by user applications once at the
     start of execution. It is not necessary to load them repeatedly.

Particulars

     SC01 serves as an umbrella routine under which the shared
     variables of its entry points are declared.  SC01 should
     never be called directly.

     The entry points of SC01 are

        SCTK01 ( SCLK to ticks,          type 1 )
        SCFM01 ( Format,                 type 1 )
        SCET01 ( ET to ticks,            type 1 )
        SCEC01 ( ET to continuous ticks, type 1 )
        SCTE01 ( Ticks to ET,            type 1 )
        SCTY01 ( Return type of SCLK )
        SCPR01 ( Return partition start and stop times, type 1 )

Examples

     See the entry points.

Restrictions

     1)  Efficiency of the conversion routines in this package
         depends on the assumption that the kernel pool is updated
         relatively infrequently. Any modification of kernel pool data,
         including setting watches, will cause entry points of this
         package to re-buffer saved SCLK data.

Literature_References

     None.

Author_and_Institution

     N.J. Bachman       (JPL)
     J. Diaz del Rio    (ODC Space)
     J.M. Lynch         (JPL)
     B.V. Semenov       (JPL)
     E.D. Wright        (JPL)

Version

    SPICELIB Version 4.0.0, 01-DEC-2021 (NJB) (JDR)

        Added entry points SCPR01 (return partition data) and
        SCTY01 (indicate whether clock is type 1).

        Updated all entry points to support buffering of data for
        multiple clocks.

        Added error checks for invalid time system codes.

        Edited headers of umbrella routine and all entry points to
        comply with NAIF standard.

    SPICELIB Version 3.4.0, 09-SEP-2013 (BVS)

        Updated to keep track of the POOL counter and call ZZCVPOOL.

    SPICELIB Version 3.3.0, 05-MAR-2009 (NJB)

        Bug fix: the entry points of this routine now keep track of
        whether their kernel pool look-ups succeeded. If not, a kernel
        pool lookup is attempted on the next call to any entry point
        of this routine.

    SPICELIB Version 3.2.0, 17-FEB-2008 (NJB)

        Bug fix: changed maximum value arguments to 1 in
        calls to SCLI01 to fetch NFIELD and DELCDE values.

        Bug fix: spaces between fields are now inserted
        correctly when the output field delimiter is blank.

    SPICELIB Version 3.1.1, 22-AUG-2006 (EDW)

        Replaced references to LDPOOL with references
        to FURNSH.

    SPICELIB Version 3.1.0, 24-JAN-2003 (BVS)

        Increased MXCOEF to 10000.

    SPICELIB Version 3.0.0, 09-MAR-1999 (NJB)

        Added new entry point SCEC01. Removed some extraneous
        C's from column 1; these had been added by a wayward
        preprocessor.

        Removed local variable RNDCLK; entry point SCTE01 no longer
        creates a rounded version of its input argument.

        Updated/fixed various comments here and in entry SCET01.

    SPICELIB Version 2.1.0, 07-JUL-1996 (NJB)

        Removed declaration, DATA and SAVE statements for unused
        variables NFDMSG and OLDID.

    SPICELIB Version 2.0.0, 17-APR-1992 (NJB)

        All entry points were updated to handle SCLK kernels that
        map between SCLK and a variety of time systems; formerly
        only TDB was supported. All entry points have had corrections
        and additions made to their headers. Comment section for
        permuted index source lines was added following the header.

    SPICELIB Version 1.0.0, 03-SEP-1990 (NJB) (JML)