Index Page
cspice_frmnam
A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X 

Abstract
I/O
Examples
Particulars
Required Reading
Version
Index_Entries

Abstract


   CSPICE_FRMNAM retrieves the name of a reference frame associated with a
   SPICE frame ID code.

   For important details concerning this module's function, please refer to
   the CSPICE routine frmnam_c.

I/O


   Given:

      frcode   a scalar integer defining a SPICE reference frame code.

   the call:

      cspice_frmnam, frcode, frname

   returns:

      frname   a scalar string containing the name corresponding to the 'frcode'
               code.

               If 'frcode' is not recognized as the name of a known reference
               frame, 'frname' will be returned as an empty string.

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.

      ;;
      ;; What frame name maps to ID code 13000?
      ;;
      cspice_frmnam, 13000, frame
      print, frame

   IDL outputs:  ITRF93

Particulars


   This routine retrieves the name of a reference frame associated
   with a SPICE frame ID code.

   The ID codes stored locally are scanned for a match with frcode.
   If a match is found, the name stored locally will be returned
   as the name for the frame.

   If frcode is not a member of the list of internally stored
   ID codes, the kernel pool will be examined to see if the
   variable

      FRAME_idcode_NAME

   is present (where idcode is the decimal character equivalent
   of frcode).  If the variable is located and it has both
   character type and dimension 1, the string value of the
   kernel pool variable is returned as the name of the reference
   frame.

   Note that because the local information is always examined
   first and searches of the kernel pool are performed only
   after exhausting local information, it is not possible to
   override the local name for any reference frame that is
   known by this routine.

Required Reading


   ICY.REQ
   FRAMES.REQ

Version


   -Icy Version 1.0.1, 08-JUL-2011, EDW (JPL)

      Edits to Particulars sections so as to parallel Mice version.

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

Index_Entries


   frame ID code to frame name translation




Wed Apr  5 17:58:01 2017