Index Page
cspice_bods2c
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_BODS2C translates a string containing a body name or ID code to the
   corresponding integer code.

I/O


   Given:

      name   containing the name or ID code of a body or  object, such as a
             planet, satellite, comet, asteroid, barycenter, DSN station,
             spacecraft, or instrument.

             [n,m] = size(name); char = class(name)

                  or

             [1,n] = size(name); cell = class(name)

             If 'name' contains the name of a body or object, that name must be
             "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 `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.

             If 'name' is a string representation of an integer, for example

                '399'

             the string will be translated to the equivalent integer datum.
             The input integer need not be one recognized by the SPICE system:
             the integer need not be a built-in NAIF ID code, nor need it be
             associated with a name via run-time registration.

   the call:

      [code, found] = cspice_bods2c( name )

   returns:

      code    containing the SPICE code(s) for 'name' if 'name' contains the
              name of a body or object as determined by the SPICE name-code
              mapping subsystem. If the input argument 'name' represents an
              integer, the same integer is returned in 'code'. If neither
              mapping exists 'code' returns as 0.

              [1,n] = size(code); int32 = class(code)

      found   the flag(s) indicating if the kernel subsystem translated 'name'
              to a corresponding 'code'.

              [1,n] = size(found); logical = class(found)

              'found' and 'code' return with the same vectorization
              measure, N, as 'name'.

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.

      %
      % Retrieve the NAIF ID associated to a body name.
      %
      disp( 'Scalar:' )
      name         = 'Hyperion';
      [code,found] = cspice_bods2c( name );

      %
      % Output the mapping if it exists.
      %
      if ( found )
         txt = sprintf( 'String %s maps to ID %i', ...
                         name, code );
         disp(txt)
      end

      disp(' ')

      %
      % Create an array of strings. Include one string not an integer
      % and unknown to the SPICE system.
      %
      disp( 'Vector:' )
      name          = strvcat( 'Cassini'   , '399',  ...
                               'Planet Bob', 'MARS', ...
                               '-123456'   , '987654' );
      [code, found] = cspice_bods2c( name );

      n_elements = size(code,2);

      %
      % Loop over the output array.
      %
      for n=1:n_elements

         %
         % Check for a valid name/ID mapping.
         %
         if( found(n))
            txt = sprintf( 'String %s maps to ID %i', ...
                            name(n,:), code(n) );
            disp(txt)
         else
            txt = sprintf( 'Unknown string ID %s', name(n,:) );
            disp(txt)
         end

      end

   MATLAB outputs:

      Scalar:
      String Hyperion maps to ID 607

      Vector:
      String Cassini    maps to ID -82
      String 399        maps to ID 399
      Unknown string ID Planet Bob
      String MARS       maps to ID 499
      String -123456    maps to ID -123456
      String 987654     maps to ID 987654

Particulars


   A sister version of this routine exists named mice_bods2c that returns
   the output arguments as fields in a single structure.

   cspice_bods2c 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


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

   MICE.REQ
   NAIF_IDS.REQ

Version


   -Mice Version 1.0.2, 12-MAR-2012 (EDW), SCK (JPL)

       I/O descriptions edits to conform to Mice documentation format.

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

   -Mice Version 1.0.0, 22-NOV-2005, EDW (JPL)

Index_Entries


   body name to code


Wed Apr  5 18:00:29 2017