Index Page dskobj_c

A B C D E F G H I J K L M N O P Q R S T U V W X

Procedure Abstract Required_Reading Keywords Brief_I/O Detailed_Input | Detailed_Output Parameters Exceptions Files Particulars Examples | Restrictions Literature_References Author_and_Institution Version Index_Entries

#### Procedure

       void dskobj_c ( ConstSpiceChar   * dsk,
                       SpiceCell        * bodids )

#### Abstract

       Find the set of body ID codes of all objects for which
       topographic data are provided in a specified DSK file.

#### Required_Reading

       CELLS
       DAS
       DSK
       SETS

#### Keywords

       COVERAGE
       TOPOGRAPHY

#### Brief_I/O

       Variable  I/O  Description
       --------  ---  --------------------------------------------------
       dsk        I   Name of DSK file.
       bodids    I-O  Set of ID codes of objects in DSK file.

#### Detailed_Input

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

       bodids         is an initialized CSPICE set data structure.

                      `bodids' optionally may contain a set of body ID
                      codes on input; on output, the data already
                      present in `bodids' will be combined with ID code
                      set found for the file `dsk'.

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

#### Detailed_Output

       bodids         is a CSPICE set data structure that contains the
                      union of its contents upon input with the set of
                      body ID codes of segments in the indicated DSK
                      file.

                      The elements of CSPICE sets are unique; each ID
                      code in `bodids' 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 the 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.

       2)  If the input file is not a transfer file but has architecture
           other than DAS, the error SPICE(BADARCHTYPE) is signaled.

       3)  If the input file is a binary DAS file of type other than
           DSK, the error SPICE(BADFILETYPE) is signaled.

       4)  If the DSK file cannot be opened or read, the error will
           be diagnosed by routines called by this routine.

       5)  If the size of the output set argument `bodids' is insufficient
           to contain the actual number of ID codes of objects covered
           by the indicated DSK file, the error will be diagnosed by
           routines called by this routine.

       6)  The error SPICE(EMPTYSTRING) is signaled if the input string
           argument does not contain at least one character, since the
           input string cannot be converted to a Fortran-style string in
           this case.

       7)  The error SPICE(NULLPOINTER) is signaled if the input
           string argument pointer is null.

       8)  The error SPICE(TYPEMISMATCH) is signaled if the input
           cell data type is not integer.

#### Files

       See the description of `dsk' above.

#### Particulars

       This routine provides an API via which applications can determine
       the set of objects for which there are topographic data in a
       specified DSK file.

#### Examples

       The formatting of the results shown for this example may differ
       across platforms.

       1)  Display the coverage for each object in a specified DSK file.
           Find the set of objects in the file. Loop over the contents
           of the ID code set: find the surface ID for each item in the
           set and display the surface ID.

       Example code begins here.

          #include <stdio.h>
          #include "SpiceUsr.h"

          /.
          Program EX1

          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               dsk [ FILSIZ ];

             SpiceInt                i;
             SpiceInt                j;

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

             dskobj_c ( dsk, &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 ( dsk, 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 PC/Linux/gcc/64-bit
       platform, using as input the name of a DSK created by a code
       example in the header of dskw02_c, the output was:

          Enter name of DSK file > ../phobos_3_3_3seg.bds

          Body ID:     401
             Surface ID:  1
             Surface ID:  2
             Surface ID:  3

#### Restrictions

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

#### Literature_References

       None.

#### Author_and_Institution

       N.J. Bachman   (JPL)

#### Version

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

#### Index_Entries

       find id codes of ephemeris objects in dsk file
       find id codes of bodies in dsk file

#### Link to routine dskobj_c source file dskobj_c.c

    Wed Apr  5 17:54:32 2017