Index Page
cspice_bodvar
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_BODVAR returns a double precision vector containing the values for
   some designated body data stored in the kernel pool.

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

I/O


   Given:
   
      body   the scalar integer NAIF ID of the body for which to
             return the value(s) of 'item'
   
      item  the scalar string naming the property of 'body' to return,
             e.g. RADII, GM, POLE_RA
   
                Note that `item' *is* case-sensitive.  This attribute 
                is inherited from the case-sensitivity of kernel 
                variable names. 

   the call:
   
      cspice_bodvar, body, item, values
   
   returns:

      values   an array of the double precision values associated with
               the variable

      Note: 'values' returns a vector even when 'item' refers to a scalar, i.e.
      a scalar returns in 'values[0]'.

      Deprecated: This routine has been superseded by cspice_bodvcd and
      cspice_bodvrd.  This routine is supported only for purposes of
      backward compatibility.

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.

      ;;
      ;; Load a SPICE PCK file containing body data.
      ;;
      cspice_furnsh, 'standard.tm'

      ;;
      ;; Retrieve the radius vector of Saturn. The procedure 
      ;; searches for the kernel variable BODY699_RADII.
      ;;
      cspice_bodvar, 699, "RADII", radii
      print, radii

   IDL outputs:

      60268.000       60268.000       54364.000

   The radii vector of Saturn expressed in kilometers as 
   recorded in the PCK listed in the "standard.tm" meta-kernel.
   
   Note: cspice_bodvar signals an error if the kernel pool
   lacks the necessary data. Either initiate a catch handler:
   
      catch, err
         if err eq 0 then cspice_bodvar, 399, "RADII", radii
      catch, /cancel
   
   or test for the existence of the kernel data with cspice_bodfnd
   (the NAIF ID for Saturn has the value 699):
   
      found = cspice_bodfnd( 699, "RADII" )
   
      if (found) then begin
         cspice_bodvar, 699, "RADII", radii
      endif

Particulars


   None.

Required Reading


   ICY.REQ
   KERNEL.REQ
   PCK.REQ

Version


   -Icy Version 1.0.4, 18-MAY-2010, BVS (JPL)

      Index lines now state that this routine is deprecated.

   -Icy Version 1.0.3, 07-JAN-2010, EDW (JPL)

      Edits to header, corrected typo in deprecation text statement.

   -Icy Version 1.0.2, 08-AUG-2008, EDW (JPL)

      Minor edits to header text.
      
   -Icy Version 1.0.1, 24-OCT-2005, EDW (JPL)

      Added a call example to the I/O section.

      Included notification that NAIF deprecated this routine.
   
   -Icy Version 1.0.0, 16-JUN-2003, EDW (JPL)

Index_Entries


   DEPRECATED fetch constants for a body from the kernel pool
   DEPRECATED physical constants for a body




Wed Apr  5 17:57:59 2017