Index Page
cspice_cnmfrm
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_CNMFRM retrieves the ID code and name of the preferred 
   frame associated with a given body name.

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

I/O


   Given:

      cname    a scalar string name of an object for which a
               preferred reference frame exists.

   the call:

      cspice_cnmfrm, cname, frcode, frname, found

   returns:

      frcode   the scalar integer SPICE frame code associated with
               'cname'.

      frname   the scalar string name corresponding to 'frcode'.

      found    a scalar boolean indicating if the appropriate
               frame ID-code and frame name can be determined
               from 'cname'.

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.


      ;;
      ;; Frame code and frame name for Io.
      ;;
      cspice_cnmfrm, 'IO', frcode, frname, found
      if ( found ) then begin
         print, frcode, ' ' + frname
      endif

   IDL outputs:

      10023 IAU_IO


      ;;
      ;; Frame code and frame name for Earth
      ;;
      cspice_cnmfrm, 'EARTH', frcode, frname, found
      if ( found ) then begin
         print, frcode, ' ' + frname
      endif

   IDL outputs:

      10013 IAU_EARTH


      ;;
      ;; Frame code and frame name for The Moon (Luna)
      ;;
      cspice_cnmfrm, 'MOON', frcode, frname, found
      if ( found ) then begin
         print, frcode, ' ' + frname
      endif

   IDL outputs:

      10020 IAU_MOON

Particulars


   This routine allows the user to determine the frame that should
   be associated with a particular object. For example, if you
   need the frame name and ID associated with Io, you can call 
   cspice_cnmfrm to return these values.

   The preferred frame to use with an object is specified via one
   of the kernel pool variables:

       OBJECT_<cname>_FRAME

   where <cname> is the non-blank portion of the string CNAME.

   For those objects that have "built-in" frame names this
   routine returns the corresponding "IAU" frame and frame ID code.

Required Reading


   ICY.REQ
   FRAMES.REQ

Version


   -Icy Version 1.0.1, 11-NOV-2013, EDW (JPL)

      Edits to I/O and Particulars section so as to parallel Mice version.

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

Index_Entries


   Fetch reference frame attributes




Wed Apr  5 17:57:59 2017