Index Page ckobj_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 ckobj_c ( ConstSpiceChar  * ck,
                      SpiceCell       * ids )

#### Abstract

       Find the set of ID codes of all objects in a specified CK file.

#### Required_Reading

       CELLS
       CK
       DAF
       NAIF_IDS
       SETS

#### Keywords

       POINTING
       UTILITY

#### Brief_I/O

       Variable  I/O  Description
       --------  ---  --------------------------------------------------
       ck         I   Name of CK file.
       ids       I/O  Set of ID codes of objects in CK file.

#### Detailed_Input

       ck             is the name of a C-kernel.

       ids            is an initialized CSPICE set data structure.
                      `ids' optionally may contain a set of ID codes on
                      input; on output, the data already present in
                      `ids' will be combined with ID code set found for the
                      file `ck'.

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

#### Detailed_Output

       ids            is a CSPICE set data structure which contains
                      the union of its contents upon input with the set
                      of ID codes of each object for which pointing data
                      are present in the indicated CK file. The elements
                      of CSPICE sets are unique; hence each ID code in
                      `ids' appears only once, even if the CK file
                      contains multiple segments for that ID code.

                      See the Examples section below for a complete
                      example program showing how to retrieve the ID
                      codes from `ids'.

#### 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 DAF, the error SPICE(BADARCHTYPE) is signaled.

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

       4)  If the CK 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 `ids' is insufficient to
           contain the actual number of ID codes of objects covered by
           the indicated CK file, the error will be diagnosed by
           routines called by this routine.

       6) The error SPICE(EMPTYSTRING) is signaled if the input
          string `ck' 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
          pointer `ck' is null.

#### Files

       This routine reads a C-kernel.

#### Particulars

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

#### Examples

       1)  Display the interval-level coverage for each object in a
           specified CK file. Use tolerance of zero ticks. Do not request
           angular velocity. Express the results in the TDB time system.

           Find the set of objects in the file. Loop over the contents of
           the ID code set:  find the coverage for each item in the set and
           display the coverage.

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

              int main()
              {

                 /.
                 Local parameters
                 ./
                 #define  FILSIZ         256
                 #define  MAXIV          100000
                 #define  WINSIZ         ( 2 * MAXIV )
                 #define  TIMLEN         51
                 #define  MAXOBJ         1000

                 /.
                 Local variables
                 ./
                 SPICEDOUBLE_CELL        ( cover, WINSIZ );
                 SPICEINT_CELL           ( ids,   MAXOBJ );

                 SpiceChar               ck      [ FILSIZ ];
                 SpiceChar               lsk     [ FILSIZ ];
                 SpiceChar               sclk    [ FILSIZ ];
                 SpiceChar               timstr  [ TIMLEN ];

                 SpiceDouble             b;
                 SpiceDouble             e;

                 SpiceInt                i;
                 SpiceInt                j;
                 SpiceInt                niv;
                 SpiceInt                obj;

                 /.
                 Load a leapseconds kernel and SCLK kernel for output time
                 conversion.  Note that we assume a single spacecraft clock is
                 associated with all of the objects in the CK.
                 ./
                 prompt_c ( "Name of leapseconds kernel > ", FILSIZ, lsk );
                 furnsh_c ( lsk );

                 prompt_c ( "Name of SCLK kernel        > ", FILSIZ, sclk );
                 furnsh_c ( sclk );

                 /.
                 Get name of CK file.
                 ./
                 prompt_c ( "Name of CK file            > ", FILSIZ, ck );

                 /.
                 Find the set of objects in the CK file.
                 ./
                 ckobj_c ( ck, &ids );

                 /.
                 We want to display the coverage for each object. Loop over
                 the contents of the ID code set, find the coverage for
                 each item in the set, and display the coverage.
                 ./
                 for ( i = 0;  i < card_c( &ids );  i++  )
                 {
                    /.
                    Find the coverage window for the current object.
                    Empty the coverage window each time so we don't
                    include data for the previous object.
                    ./
                    obj  =  SPICE_CELL_ELEM_I( &ids, i );

                    scard_c ( 0,  &cover );
                    ckcov_c ( ck,          obj,  SPICEFALSE,
                              "INTERVAL",  0.0,  "TDB",       &cover );

                    /.
                    Get the number of intervals in the coverage window.
                    ./
                    niv = wncard_c( &cover );

                    /.
                    Display a simple banner.
                    ./
                    printf ( "%s\n", "========================================" );

                    printf ( "Coverage for object %d\n", (int)obj );

                    /.
                    Convert the coverage interval start and stop times to TDB
                    calendar strings.
                    ./
                    for ( j = 0;  j < niv;  j++  )
                    {
                       /.
                       Get the endpoints of the jth interval.
                       ./
                       wnfetd_c ( &cover, j, &b, &e );

                       /.
                       Convert the endpoints to TDB calendar
                       format time strings and display them.
                       ./
                       timout_c ( b,
                                  "YYYY MON DD HR:MN:SC.###### (TDB) ::TDB",
                                  TIMLEN,
                                  timstr                                    );

                       printf ( "\n"
                                "Interval:  %d\n"
                                "Start:     %s\n",
                                (int)j,
                                timstr            );

                       timout_c ( e,
                                  "YYYY MON DD HR:MN:SC.###### (TDB) ::TDB",
                                  TIMLEN,
                                  timstr                                    );
                       printf ( "Stop:      %s\n", timstr );

                    }
                    printf ( "%s\n", "========================================" );

                 }
                 return ( 0 );
              }

#### Restrictions

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

#### Literature_References

       None.

#### Author_and_Institution

       N.J. Bachman   (JPL)

#### Version

       -CSPICE Version 1.0.2, 12-JUL-2016 (EDW)

          Edit to example program to use "%d" with explicit casts
          to int for printing SpiceInts with printf.

       -CSPICE Version 1.0.1, 30-NOV-2007 (NJB)

           Corrected bug in example program in header:
           program now empties result window prior to collecting
           data for each object. Updated example to use wncard_c
           rather than card_c.

       -CSPICE Version 1.0.0, 30-DEC-2004 (NJB)

#### Index_Entries

       find id codes in ck file

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

    Wed Apr  5 17:54:29 2017