Index Page
cspice_bodc2n
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_BODC2N returns the body name corresponding to an input numeric ID 
   value.

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

I/O

   
   Given:
   
      code   the scalar integer SPICE code for a body: a planet, satellite, 
             barycenter, spacecraft, asteroid, comet, or other ephemeris object.
   
   the call:
   
      cspice_bodc2n, code, name, found 
   
   returns:
   
      name    the scalar string name associated with 'code'. 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.
 
      found   a scalar boolean flagging if the kernel subsystem translated 
              'code' to a corresponding name; true if code has a translation.  
              Otherwise, found is false.
   

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.

   
      ;;
      ;; Query for the name mapped to -77.
      ;;
      code = -77
      
      cspice_bodc2n, code, name, found
   
      ;;
      ;; Respond if found.
      ;;
      if ( found ) then begin
         print, 'Name corresponding to code: ', name
      endif else begin
         print, 'No name corresponding to code: ', code
      endelse
   
   IDL outputs:
   
      Name corresponding to code: GALILEO ORBITER

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.1, 16-MAY-2009 (EDW) 

       Edit to Particulars section to document the cspice_bodc2s routine.
       Extended argument descriptions in the I/O section.

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

Index_Entries


   body id code to name




Wed Apr  5 17:57:59 2017