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

Table of contents

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

       pckfrm_c ( PCK, get reference frame class ID set )

       void pckfrm_c ( ConstSpiceChar  * pckfnm,
                       SpiceCell       * ids  )

#### Abstract

       Find the set of reference frame class ID codes of all frames
       in a specified binary PCK file.

#### Required_Reading

       CELLS
       DAF
       SETS
       PCK

#### Keywords

       ORIENTATION
       UTILITY

#### Brief_I/O

       VARIABLE  I/O  DESCRIPTION
       --------  ---  --------------------------------------------------
       pckfnm     I   Name of PCK file.
       ids       I-O  Set of frame class ID codes of frames in PCK file.

#### Detailed_Input

       pckfnm      is the name of a binary PCK file.

       ids         is an initialized SPICE 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 `pckfnm'.

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

                   `ids' must be declared as an integer SpiceCell.

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

                      SPICEINT_CELL           ( ids, IDSSZ );

                   where IDSSZ is the maximum capacity of `ids'.

#### Detailed_Output

       ids         is a SPICE set data structure which contains the union
                   of its contents upon input with the set of reference
                   frame class ID codes of each frame for which data are
                   present in the indicated PCK file. The elements of
                   SPICE sets are unique; hence each ID code in `ids'
                   appears only once, even if the PCK 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 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 DAF, the error SPICE(INVALIDARCHTYPE) is signaled
           by a routine in the call tree of this routine.

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

       4)  If the PCK 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 `ids' is insufficient to
           contain the actual number of ID codes of frames covered by the
           indicated PCK file, an error is signaled by a routine in the
           call tree of this routine.

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

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

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

#### Files

       None.

#### Particulars

       This routine provides an API via which applications can determine
       the set of reference frames for which there are data in a
       specified PCK file.

#### 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) Display the coverage for each frame in a specified PCK file.
          Find the set of frames 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.

          Example code begins here.

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

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

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

             SpiceChar               lsk     [ FILSIZ ];
             SpiceChar               pckfnm  [ FILSIZ ];
             SpiceChar               timstr  [ TIMLEN ];

             SpiceDouble             b;
             SpiceDouble             e;

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

             /.
             Load a leapseconds kernel for output time conversion.
             pckcov_c itself does not require a leapseconds kernel.
             ./
             prompt_c ( "Name of leapseconds kernel > ", FILSIZ, lsk );
             furnsh_c ( lsk );

             /.
             Get name of PCK file.
             ./
             prompt_c ( "Name of PCK file           > ", FILSIZ, pckfnm );

             /.
             Find the set of frames in the PCK file.
             ./
             pckfrm_c ( pckfnm, &ids );

             /.
             We want to display the coverage for each frame. 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 frame.
                Empty the coverage window each time so we don't
                include data for the previous frame.
                ./
                obj  =  SPICE_CELL_ELEM_I( &ids, i );

                scard_c  ( 0,        &cover );
                pckcov_c ( pckfnm, obj, &cover );

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

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

                printf ( "Coverage for frame %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 );

                }

             }
             return ( 0 );
          }

          When this program was executed on a Mac/Intel/cc/64-bit
          platform, using the LSK file named naif0012.tls, and the PCK
          file named earth_720101_070426.bpc, the output was:

          Name of leapseconds kernel > naif0012.tls
          Name of PCK file           > earth_720101_070426.bpc
          ========================================
          Coverage for frame 3000

          Interval:  0
          Start:     1962 JAN 20 00:00:41.184 (TDB)
          Stop:      2007 APR 26 00:01:05.185 (TDB)

#### 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)
       J. Diaz del Rio     (ODC Space)
       E.D. Wright         (JPL)

#### Version

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

           Changed input argument name "pck" to "pckfnm" for consistency with other
           routines.

           Edited the header to comply with NAIF standard. Corrected short error
           message in entries #2 and #3 in -Exceptions section. Added example's
           solution.

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

           Added entry #8 to -Exceptions section.

       -CSPICE Version 1.0.1, 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.0, 01-DEC-2007 (NJB)

#### Index_Entries

       find frame class id codes of frames in binary PCK file

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

    Fri Dec 31 18:41:10 2021