Procedure

     SCN2ID  ( SCLK name to ID code )

     ENTRY SCN2ID ( CLKNAM, CLKID, FOUND )

Abstract

     Convert an SCLK name string to a NAIF integer code.

Required_Reading

     SCLK

Keywords

     CONVERSION
     PARSING
     SCLK
     TIME
     UTILITY

Declarations

    IMPLICIT NONE

    CHARACTER*(*)         CLKNAM
    INTEGER               CLKID
    LOGICAL               FOUND

Brief_I/O

     VARIABLE  I/O  DESCRIPTION
     --------  ---  --------------------------------------------------
     CLKNAM     I   String giving spacecraft clock name.
     CLKID      O   NAIF integer code of spacecraft clock.
     FOUND      O   Flag indicating whether item was found.

Detailed_Input

     CLKNAM   is a short string identifying the spacecraft
              clock of interest. The form of the string
              is:

                 <spacecraft name or acronym> SCLK

              for example

                 VGR1 SCLK
                 VOYAGER 1 SCLK
                 GLL SCLK
                 GALILEO ORBITER SCLK

              Case and white space (including embedded white
              space) are not significant.

Detailed_Output

     CLKID    is the NAIF integer code associated with the
              input clock. CLKID is defined only if the
              output flag FOUND is returned .TRUE.

     FOUND    is a logical flag indicating whether the input
              string specified a clock known to this routine.

Parameters

     None.

Exceptions

     Error free.

     1)  If the input name is not recognized, FOUND is set to .FALSE.
         CLKID is not modified.

     2)  If the input name is recognized but does not refer to a
         spacecraft, no error is signaled. For example, the string
         'JUPITER BARYCENTER SCLK' maps to the code 5.

Files

     None.

Particulars

     SCN2ID provides a means of mapping human-readable clock names
     to integer codes used by the SPICELIB SCLK routines to
     identify spacecraft clocks.

Examples

     1)  Look up the spacecraft clock code for the Galileo orbiter.

            CALL SCN2ID ( 'GLL SCLK', CLKID, FOUND )

         The outputs will be

            CLKID  =  -77
            FOUND  =  .TRUE.

Restrictions

     None.

Literature_References

     None.

Author_and_Institution

     N.J. Bachman       (JPL)
     J. Diaz del Rio    (ODC Space)

Version

    SPICELIB Version 1.2.1, 12-AUG-2021 (JDR)

        Edited the header to comply with NAIF standard.

    SPICELIB Version 1.2.0, 12-AUG-2001 (NJB)

        Bug fix: modified algorithm to handle case where string
        "SCLK" appears in SCLK name.

    SPICELIB Version 1.1.0, 25-FEB-2000 (NJB)

        Updated to use BODTRN for SCLK name/code mapping.

    SPICELIB Version 1.0.0, 17-NOV-1995 (NJB)