Index Page
cspice_bodc2s
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_BODC2S translates a body ID code to either the corresponding name
   or if no name to ID code mapping exists, the string representation of the 
   body ID value.

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

I/O

   
   Given:

      code   the integer scalar SPICE ID code for a body: planet, satellite, 
             barycenter, spacecraft, asteroid, comet, or other ephemeris 
             object.

   the call:
   
      cspice_bodc2s, code, name 
   
   returns:

      name   the string name of the body identified by 'code' if a mapping  
             between 'code' and a body name exists within SPICE.

             If 'code' has more than one translation, then the most recently
             defined 'name' corresponding to 'code' is returned. 'name' will
             have the exact format (case and blanks) as when the name/code pair
             was defined.

             If the input value of 'code' does not map to a body name, 'name' 
             returns with the string representation of 'code'.

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.

      ;;
      ;; Assign an array of body ID codes. Not all the listed codes
      ;; map to a body name.
      ;;
      code = [ 399L, 0, 3, -77, 1, -1, 6000001 ]


      ;;
      ;; Loop over the 'code' array, call bodc2s_c for each
      ;; element of 'code'.
      ;;
      for i=0, 6 do begin
 
         cspice_bodc2s, code[i], name
         print, format='(I8,3x,A)', code[i], name

      endfor
    
   IDL outputs:

           399   EARTH
             0   SOLAR SYSTEM BARYCENTER
             3   EARTH BARYCENTER
           -77   GALILEO ORBITER
            11   11
            -1   GEOTAIL
       6000001   6000001
 
   The codes 11 and 6000001 did not map to a name so the call
   returns as 'name' the string expression of the codes.

Particulars


   cspice_bodc2n is one of five related subroutines,

      cspice_bods2c      Body string to code
      cspice_bodc2s      Body code to string
      cspice_bodn2c      Body name to code
      cspice_bodc2n      Body code to name
      cspice_boddef      Body name/code definition

   cspice_bods2c, cspice_bodc2s, cspice_bodn2c, and cspice_bodc2n 
   perform translations between body names and their corresponding 
   integer ID codes which are used in SPICE files and routines.

   cspice_bods2c is a slightly more general version of cspice_bodn2c: 
   support for strings containing ID codes in string format enables a caller
   to identify a body using a string, even when no name is associated with 
   that body.

   cspice_bodc2s is a general version of cspice_bodc2n; the routine returns 
   either the name assigned in the body ID to name mapping or a string
   representation of the 'code' value if no mapping exists.

   cspice_boddef assigns a body name to ID mapping. The mapping has
   priority in name-to-ID and ID-to-name translations.

   Refer to NAIF_IDS.REQ for the list of name/code associations built
   into SPICE, and for details concerning adding new name/code
   associations at run time by loading text kernels.

Required Reading


   ICY.REQ
   NAIF_IDS.REQ

Version


   -Icy Version 1.0.0, 01-JUN-2009, EDW (JPL)

Index_Entries


   body id code to string




Wed Apr  5 17:57:59 2017