Index Page
cspice_bodn2c
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_BODN2C translates the name of a body or object to the corresponding 
   SPICE integer ID code.

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

I/O

   
   Given:
   
      name    the scalar string name of a body or object, such as a planet, 
              satellite, comet, asteroid, barycenter, DSN station, spacecraft, 
              or instrument, "known" to the SPICE system, whether through 
              hard-coded registration or run-time registration in the SPICE 
              kernel pool.
 
              Case and leading and trailing blanks in a name are not 
              significant. However when a name is made up of more than one word,
              they must be separated by at least one blank.  That is, all of 
              the following strings are equivalent names:

                      'JUPITER BARYCENTER'
                      'Jupiter Barycenter'
                      'JUPITER BARYCENTER   '
                      'JUPITER    BARYCENTER'
                      '   JUPITER BARYCENTER'

              However, 'JUPITERBARYCENTER' is not equivalent to the names above.

   the call:
   
      cspice_bodn2c, name, code, found 
   
   returns:
   
      code    the scalar, integer SPICE code assigned either by 
              SPICE or the user to 'name'.
   
      found   a scalar boolean flagging if the kernel subsystem
              translated 'name' to a corresponding '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.

   
      ;;
      ;; Query for the code mapped to Galileo Orbiter.
      ;;
      name = 'Galileo Orbiter'
      
      cspice_bodn2c, name, code, found
   
      ;;
      ;; Respond if found.
      ;;
      if ( found ) then begin
         print, 'Code corresponding to name: ', code
      endif else begin
         print, 'No code corresponding to name: ', name
      endelse
   
   IDL outputs:
   
      Code corresponding to name:   -77

Particulars


   cspice_bodn2c 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.

   Programmers writing user interface code should consider using the
   Icy routine cspice_bods2c. cspice_bods2c provides more flexibility 
   in handling input strings, since it accepts both body names and
   strings representing integer ID codes, for example '399'.

   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 name to code




Wed Apr  5 17:57:59 2017