Index Page
cspice_frinfo
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_FRINFO retrieves the minimal attributes associated with a
   frame needed for converting transformations to and from it.

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

I/O


   Given:

      frcode   an integer SPICE ID for some reference frame.

   the call:

      cspice_frinfo, frcode, cent, clss, clssid, found

   returns:

      cent     the scalar integer SPICE body ID for the center of the
               reference frame (if such an ID is appropriate).

      clss     the scalar integer class ID or type of the frame. This
               identifies which subsystem will perform frame transformations.

      clssid   the scalar integer ID used for the frame within its class.
               This may be different from the frame ID.

      found    a scalar boolean indicating if 'cent', 'frclss' and 'frcode' are
               available, true if so, false if not.

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.

      ;;
      ;; Output the frame information for frame 13000.
      ;;
      cspice_frinfo, 13000, cent, clss, clssid, found
      print, 'Frame center  : ', cent
      print, 'Frame class   : ', clss
      print, 'Frame class ID: ', clssid

   IDL outputs:

      Frame center  :          399
      Frame class   :            2
      Frame class ID:         3000

Particulars


   This is a low level routine needed by state transformation
   software to transform states and attitudes between different
   reference frames.

   The routine first examines local "hard-coded" information about
   reference frames to see if the requested frame belongs to this
   set.  If it does that information is returned.

   If the requested information is not stored locally, the routine
   then examines the kernel pool to see if the requested information
   is stored there.  If it is and has the expected format, the data
   is retrieved and returned.

Required Reading


   ICY.REQ
   FRAMES.REQ

Version


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

      Edits to I/O and Particulars sections 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:58:01 2017