Procedure

   dsksrf_c ( DSK, get surface IDs for body ) 

   void dsksrf_c ( ConstSpiceChar  * dskfnm,
                   SpiceInt          bodyid,
                   SpiceCell       * srfids )

Abstract

   Find the set of surface ID codes for all surfaces associated with
   a given body in a specified DSK file.

Required_Reading

   CELLS
   DAS
   DSK
   NAIF_IDS
   SETS

Keywords

   COVERAGE
   SURFACE
   TOPOGRAPHY

Brief_I/O

   VARIABLE  I/O  DESCRIPTION
   --------  ---  --------------------------------------------------
   dskfnm     I   Name of DSK file.
   bodyid     I   Integer body ID code.
   srfids    I-O  Set of ID codes of surfaces in DSK file.

Detailed_Input

   dskfnm      is the name of a DSK file. This file will be opened for
               read access by this routine.

   bodyid      is the integer ID code of a body for which topographic
               data are present in the specified DSK file.

   srfids      is an initialized SPICE set data structure.

               `srfids' optionally may contain a set of surface ID codes
               on input; on output, the ID codes already present in
               `srfids' will be combined with surface ID code set found
               for the body designated by `bodyid' in the file `dskfnm'.

               If `srfids' contains no data on input, its size and
               cardinality still must be initialized.

               `srfids' must be declared as an integer SpiceCell.

               CSPICE provides the following macro, which declares and
               initializes the cell

                  SPICEINT_CELL           ( srfids, SRFIDSSZ );

               where SRFIDSSZ is the maximum capacity of `srfids'.

Detailed_Output

   srfids      is a SPICE set data structure that contains the union
               of its contents upon input with the set of ID codes of
               the surfaces associated with the body designated by
               `bodyid', for which segments were found in the indicated
               DSK file.

               The elements of SPICE sets are unique; each ID code in
               `srfids' appears only once, even if the DSK file contains
               multiple segments for that ID code.

               See the -Examples section below for a complete example
               program showing how to retrieve body and surface ID codes
               from a DSK file.

Parameters

   None.

Exceptions

   1)  If the input file has transfer format, the error
       SPICE(INVALIDFORMAT) is signaled by a routine in the call tree
       of this routine.

   2)  If the input file is not a transfer file but has architecture
       other than DAS, the error SPICE(INVALIDARCHTYPE) is signaled
       by a routine in the call tree of this routine.

   3)  If the input file is a binary DAS file of type other than DSK,
       the error SPICE(INVALIDFILETYPE) is signaled by a routine in
       the call tree of this routine.

   4)  If the DSK file cannot be opened or read, an error is signaled
       by a routine in the call tree of this routine.

   5)  If the size of the output set argument `srfids' is insufficient
       to contain the actual number of ID codes of surfaces covered
       by the indicated DSK file, the error SPICE(CELLTOOSMALL) is
       signaled by a routine in the call tree of this routine.

   6)  If the `dskfnm' input string pointer is null, the error
       SPICE(NULLPOINTER) is signaled.

   7)  If the `dskfnm' input string has zero length, the error
       SPICE(EMPTYSTRING) is signaled.

   8)  If the `srfids' cell argument has a type other than SpiceInt,
       the error SPICE(TYPEMISMATCH) is signaled.

Files

   See the description of the argument `dskfnm' above.

Particulars

   This routine provides an API via which applications can determine
   the set of surfaces associated with a given body in a specified
   DSK file. This routine is normally used together with dskobj_c.

Examples

   The numerical results shown for this example may differ across
   platforms. The results depend on the SPICE kernels used as
   input, the compiler and supporting libraries, and the machine
   specific arithmetic implementation.

   1) Examine a DSK file and identify the set of central bodies
      associated with the segments in the file. For each body, find
      the set of surfaces associated with that body.


      Example code begins here.


      /.
         Program dsksrf_ex1
      ./
      #include <stdio.h>
      #include "SpiceUsr.h"

      /.
      Examine a DSK file and identify the set of
      central bodies associated with the segments
      in the file. For each body, find the
      set of surfaces associated with that body.
      ./
      int main()
      {
         /.
         Local constants
         ./
         #define FILSIZ          256
         #define MAXID           10000

         /.
         Local variables
         ./
         SPICEINT_CELL         ( bodids, MAXID );
         SPICEINT_CELL         ( srfids, MAXID );

         SpiceChar               dskfnm [ FILSIZ ];

         SpiceInt                i;
         SpiceInt                j;

         /.
         Prompt for the name of a DSK file.
         ./
         prompt_c ( "Enter name of DSK file > ", FILSIZ, dskfnm );

         dskobj_c ( dskfnm, &bodids );

         for ( i = 0;  i < card_c( &bodids );  i++ )
         {
            printf ( "\n"
                     "Body ID:     %d\n",
                     (int)SPICE_CELL_ELEM_I( &bodids, i) );

            /.
            Get the surface IDs for the Ith body.
            ./
            dsksrf_c ( dskfnm, SPICE_CELL_ELEM_I( &bodids, i), &srfids );

            for ( j = 0;  j < card_c( &srfids );  j++ )
            {
               printf ( "   Surface ID:  %d\n",
                        (int)SPICE_CELL_ELEM_I( &srfids, j) );
            }
         }
         return ( 0 );
      }


      When this program was executed on a Mac/Intel/cc/64-bit
      platform, using the DSK file named phobos512.bds, the output
      was:


      Enter name of DSK file > phobos512.bds

      Body ID:     401
         Surface ID:  401

Restrictions

   1)  If an error occurs while this routine is updating the set
       `srfids', the set may be corrupted.

Literature_References

   None.

Author_and_Institution

   N.J. Bachman        (JPL)
   J. Diaz del Rio     (ODC Space)

Version

   -CSPICE Version 1.1.0, 24-AUG-2021 (JDR)

       Changed input argument name "dsk" to "dskfnm" for consistency with other
       routines.

       Edited the header to comply with NAIF standard. Replaced example's
       kernel. Corrected short error message in entries #2, #3 and #5, and
       added entries #6 and #7 in -Exceptions section.

       Extended description of argument "srfids" in -Detailed_Input to include
       type and preferred declaration method.

   -CSPICE Version 1.0.0, 28-JAN-2016 (NJB)

Index_Entries

   find id codes of surfaces in DSK file