Index Page pckcov_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 pckcov_c ( ConstSpiceChar   * pck,
                       SpiceInt           idcode,
                       SpiceCell        * cover   )
#### Abstract
       Find the coverage window for a specified reference frame in a
       specified binary PCK file.
#### Required_Reading
       CELLS
       DAF
       PCK
       TIME
       WINDOWS
#### Keywords
       ORIENTATION
       TIME
       UTILITY
#### Brief_I/O
       Variable  I/O  Description
       --------  ---  --------------------------------------------------
       pck        I   Name of PCK file.
       idcode     I   Class ID code of PCK reference frame.
       cover     I/O  Window giving coverage in `pck' for `idcode'.
#### Detailed_Input
       pck            is the name of a binary PCK file.

       idcode         is the integer frame class ID code of a PCK reference
                      frame for which data are expected to exist in the
                      specified PCK file.

       cover          is an initialized CSPICE window data structure.
                      `cover' optionally may contain coverage data on
                      input; on output, the data already present in `cover'
                      will be combined with coverage found for the
                      reference frame designated by `idcode' in the file
                      `pck'.

                      If `cover' contains no data on input, its size and
                      cardinality still must be initialized.
#### Detailed_Output
       cover          is a CSPICE window data structure which represents
                      the merged coverage for the reference frame having
                      frame class ID `idcode'. This is the set of time
                      intervals for which data for `idcode' are present in
                      the file `pck', merged with the set of time intervals
                      present in `cover' on input.  The merged coverage is
                      represented as the union of one or more disjoint time
                      intervals. The window `cover' contains the pairs of
                      endpoints of these intervals.

                      The interval endpoints contained in `cover' are
                      ephemeris times, expressed as seconds past J2000
                      TDB.

                      See the Examples section below for a complete
                      example program showing how to retrieve the
                      endpoints from `cover'.
#### 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
           PCK, the error SPICE(BADFILETYPE) is signaled.

       4)  If the PCK file cannot be opened or read, the error will
           be diagnosed by routines called by this routine. The output
           window will not be modified.

       5)  If the size of the output window argument COVER is
           insufficient to contain the actual number of intervals in the
           coverage window for IDCODE, the error will be diagnosed by
           routines called by this routine.

       6)  The error SPICE(EMPTYSTRING) is signaled if the input
           string `pck' 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 `pck' is null.
#### Files
       This routine reads a PCK file.
#### Particulars
       This routine provides an API via which applications can determine
       the coverage a specified PCK file provides for a specified
       PCK class reference frame.
#### Examples
       1)  This example demonstrates combined usage of pckcov_c and the
           related PCK utility pckfrm_c.

           Display the coverage for each object in a specified PCK file.
           Find the set of objects in the file; for each object, find
           and display the coverage.

              #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               pck     [ 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 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, pck    );

                 /.
                 Find the set of frames in the PCK file.
                 ./
                 pckfrm_c ( pck, &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 ( pck, 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 %ld\n", 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:  %ld\n"
                                "Start:     %s\n",
                                j,
                                timstr            );

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

                    }

                 }
                 return ( 0 );
              }

       2) Find the coverage for the frame designated by `idcode'
          provided by the set of PCK files loaded via a metakernel.
          (The metakernel must also specify a leapseconds kernel.)

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

             int main()
             {

                /.
                Local parameters
                ./
                #define  FILSIZ         256
                #define  LNSIZE         81
                #define  MAXCOV         100000
                #define  WINSIZ         ( 2 * MAXCOV )
                #define  TIMLEN         51

                /.
                Local variables
                ./
                SPICEDOUBLE_CELL        ( cover, WINSIZ );

                SpiceBoolean            found;

                SpiceChar               file    [ FILSIZ ];
                SpiceChar               idch    [ LNSIZE ];
                SpiceChar               meta    [ FILSIZ ];
                SpiceChar               source  [ FILSIZ ];
                SpiceChar               timstr  [ TIMLEN ];
                SpiceChar               type    [ LNSIZE ];

                SpiceDouble             b;
                SpiceDouble             e;

                SpiceInt                count;
                SpiceInt                handle;
                SpiceInt                i;
                SpiceInt                idcode;
                SpiceInt                niv;

                /.
                Prompt for the metakernel name; load the metakernel.
                The metakernel lists the PCK files whose coverage
                for `idcode' we'd like to determine.  The metakernel
                must also specify a leapseconds kernel.
                ./
                prompt_c ( "Name of metakernel > ", FILSIZ, meta );
                furnsh_c ( meta );

                /.
                Get the ID code of interest.
                ./
                prompt_c ( "Enter ID code      > ", LNSIZE, idch );
                prsint_c ( idch,  &idcode );

                /.
                Find out how many kernels are loaded.  Loop over the
                kernels:  for each loaded PCK file, add its coverage
                for `idcode', if any, to the coverage window.
                ./
                ktotal_c ( "PCK", &count );

                for ( i = 0;  i < count;  i++  )
                {
                   kdata_c  ( i,     "PCK",   FILSIZ,  LNSIZE,   FILSIZ,
                              file,  type,    source,  &handle,  &found );

                   pckcov_c ( file,  idcode,  &cover );
                }

                /.
                Display results.

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

                /.
                Display a simple banner.
                ./
                printf ( "\nCoverage for frame %ld\n", idcode );

                /.
                Convert the coverage interval start and stop times to TDB
                calendar strings.
                ./
                for ( i = 0;  i < niv;  i++  )
                {
                   /.
                   Get the endpoints of the ith interval.
                   ./
                   wnfetd_c ( &cover, i, &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:  %ld\n"
                            "Start:     %s\n",
                            i,
                            timstr            );

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

                }
                return ( 0 );
             }
#### Restrictions
       1) If an error occurs while this routine is updating the window
          `cover', the window may be corrupted.
#### Literature_References
       None.
#### Author_and_Institution
       N.J. Bachman   (JPL)
#### Version
       -CSPICE Version 1.0.0, 30-NOV-2007 (NJB)
#### Index_Entries
       get coverage window for binary pck reference frame
#### Link to routine pckcov_c source file pckcov_c.c

    Wed Jun  9 13:05:27 2010