Abstract

   CSPICE_NAMFRM retrieves the SPICE frame ID code associated
   with a frame name.

I/O

   Given:

      frname   a character string that stands for some reference frame (either
               inertial or non-inertial).

               help, frname
                  STRING = Scalar

               Leading blanks in `frname' are ignored. And the
               case of the letters in `frname' are insignificant.

               Note that all legitimate frame names contain
               26 or fewer characters.

   the call:

      cspice_namfrm, frname, frcode

   returns:

      frcode   the SPICE integer code used for internal representation of the
               named reference frame.

               help, frcode
                  LONG = Scalar

               If the name input through `frname' is not recognized
               `frcode' will be returned with a value of zero.

Parameters

   None.

Examples

   Any numerical results shown for this example may differ between
   platforms as the results depend on the SPICE kernels used as input
   and the machine specific arithmetic implementation.

   1) Given a frame name, retrieve its associated SPICE frame ID.


      Example code begins here.


      PRO namfrm_ex1

         ;;
         ;; What's the frame ID for frame J2000?
         ;;
         cspice_namfrm, 'J2000', val
         print, 'Frame ID for frame J2000: ', val

      END


      When this program was executed on a Mac/Intel/IDL8.x/64-bit
      platform, the output was:


      Frame ID for frame J2000:            1

Particulars

   This is a low level interface routine intended primarily for
   use within the SPK and CK systems to assist in the transformation
   to user specified reference frames.

   The routine first consults a stored list of reference frame
   names in an attempt to determine the appropriate reference
   frame code.

   If this search is unsuccessful, the routine then examines the
   kernel pool to determine whether or not a variable of the
   form

      'FRAME_' + frname

      (where leading blanks of `frname' are ignored)

   is present. If it is and the number of values associated with the
   name is 1, this value is taken to be the frame ID code.

   Note: It is NOT possible to override the default names and
   ID codes stored locally in this routine by placing an
   appropriately variable in the kernel pool with a different
   ID code. The predefined values always take precedence.

   Consult the frames.req required reading document for more details
   about constructing your own frame definitions.

Exceptions

   1)  If the input name is not recognized, `frcode' will be
       returned with a value of 0.

   2)  If the input argument `frname' is undefined, an error is
       signaled by the IDL error handling system.

   3)  If the input argument `frname' is not of the expected type, or
       it does not have the expected dimensions and size, an error is
       signaled by the Icy interface.

   4)  If the output argument `frcode' is not a named variable, an
       error is signaled by the Icy interface.

Files

   None.

Restrictions

   None.

Required_Reading

   ICY.REQ
   FRAMES.REQ

Literature_References

   None.

Author_and_Institution

   J. Diaz del Rio     (ODC Space)
   E.D. Wright         (JPL)

Version

   -Icy Version 1.0.1, 01-JUN-2021 (JDR)

       Edited the header to comply with NAIF standard. Added example's
       problem statement and reformatted example's output.

       Added -Parameters, -Exceptions, -Files, -Restrictions,
       -Literature_References and -Author_and_Institution sections, and
       completed -Particulars section.

       Added FRAMES to the list of required readings.

       Removed reference to the routine's corresponding CSPICE header from
       -Abstract section.

       Added arguments' type and size information in the -I/O section.

   -Icy Version 1.0.0, 16-JUN-2003 (EDW)

Index_Entries

   Frame name to frame idcode translation