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
cspice_dafcls

Table of contents
Abstract
I/O
Parameters
Examples
Particulars
Exceptions
Files
Restrictions
Required_Reading
Literature_References
Author_and_Institution
Version
Index_Entries


Abstract


   CSPICE_DAFCLS closes the DAF referred to by a handle.

I/O


   Given:

      handle   the scalar integer file handle referring to a DAF.

               help, handle
                  LONG = Scalar

   the call:

      cspice_dafcls, handle

   closes the DAF, i.e. removes the file from read or write
   access by the SPICE DAF subsystem.

   Use this routine to close files opened by cspice_dafopr and
   cspice_dafopw.

   returns:

      None.

Parameters


   None.

Examples


   Any numerical results shown for this example may differ between
   platforms as the results depend on the SPICE kernels used as input
   and the machine specific arithmetic implementation.

   1) Create a simple program to output the double precision and integer
      values stored in an SPK's segments' descriptors. This program
      opens a DAF for read, performs a forwards search for the DAF
      arrays, prints the segment descriptor for each array found, then
      closes the DAF.

      Use the SPK kernel below as input DAF file for the program.

         de421.bsp


      Example code begins here.


      PRO dafcls_ex1

         ;;
         ;; Local constants
         ;;
         kernel = 'de421.bsp'

         ;;
         ;; Open a DAF for read. Return a `handle' referring to the file.
         ;;
         cspice_dafopr, kernel, handle

         ;;
         ;; Define the summary parameters appropriate
         ;; for an SPK file.
         ;;
         ND = 2L
         NI = 6L

         ;;
         ;; Begin a forward search on the file.
         ;;
         cspice_dafbfs, handle

         ;;
         ;; Search until a DAF array is found.
         ;;
         cspice_daffna, found

         ;;
         ;; Loop while the search finds subsequent DAF arrays.
         ;;
         while found do begin

            cspice_dafgs, ND, NI, dc, ic

            print, 'Doubles:  ', dc

            print, FORMAT='(A,6I8)', 'Integers: ', ic
            print, ' '

            ;;
            ;; Check for another segment.
            ;;
            cspice_daffna, found

         endwhile

         ;;
         ;; Safely close the DAF file.
         ;;
         cspice_dafcls, handle

      END


      When this program was executed on a Mac/Intel/IDL8.x/64-bit
      platform, the output was:


      Doubles:    -3.1691952e+09   1.6968528e+09
      Integers:        1       0       1       2     641  310404

      Doubles:    -3.1691952e+09   1.6968528e+09
      Integers:        2       0       1       2  310405  423048

      Doubles:    -3.1691952e+09   1.6968528e+09
      Integers:        3       0       1       2  423049  567372

      Doubles:    -3.1691952e+09   1.6968528e+09
      Integers:        4       0       1       2  567373  628976

      Doubles:    -3.1691952e+09   1.6968528e+09
      Integers:        5       0       1       2  628977  674740

      Doubles:    -3.1691952e+09   1.6968528e+09
      Integers:        6       0       1       2  674741  715224

      Doubles:    -3.1691952e+09   1.6968528e+09
      Integers:        7       0       1       2  715225  750428

      Doubles:    -3.1691952e+09   1.6968528e+09
      Integers:        8       0       1       2  750429  785632

      Doubles:    -3.1691952e+09   1.6968528e+09
      Integers:        9       0       1       2  785633  820836

      Doubles:    -3.1691952e+09   1.6968528e+09
      Integers:       10       0       1       2  820837  944040

      Doubles:    -3.1691952e+09   1.6968528e+09
      Integers:      301       3       1       2  944041 1521324

      Doubles:    -3.1691952e+09   1.6968528e+09
      Integers:      399       3       1       2 1521325 2098608

      Doubles:    -3.1691952e+09   1.6968528e+09
      Integers:      199       1       1       2 2098609 2098620

      Doubles:    -3.1691952e+09   1.6968528e+09
      Integers:      299       2       1       2 2098621 2098632

      Doubles:    -3.1691952e+09   1.6968528e+09
      Integers:      499       4       1       2 2098633 2098644


   Note, the specific contents of `ic' and `dc' depend on the
   type of DAF.

   Note, the final entries in the integer array contain the segment
   start/end indexes. The output indicates the search proceeded
   from the start of the file (low value index) towards the end
   (high value index).

Particulars


   Because the DAF subsystem must keep track of what files are open at
   any given time, it is important that DAF files be closed only with
   cspice_dafcls, to prevent the remaining DAF routines from failing,
   sometimes mysteriously.

   Note that when a file is opened more than once for read access,
   cspice_dafopr returns the same handle each time it is re-opened.
   Each time the file is closed, cspice_dafcls checks to see if any other
   claims on the file are still active before physically closing
   the file.

Exceptions


   1)  If the specified handle does not belong to a DAF
       that is currently open, nothing happens.

   2)  If this routine is used to close a `handle' not associated with
       a DAF, an error is signaled by a routine in the call tree of
       this routine.

   3)  If the input argument `handle' is undefined, an error is
       signaled by the IDL error handling system.

   4)  If the input argument `handle' is not of the expected type, or
       it does not have the expected dimensions and size, an error is
       signaled by the Icy interface.

Files


   None.

Restrictions


   None.

Required_Reading


   DAF.REQ
   ICY.REQ

Literature_References


   None.

Author_and_Institution


   J. Diaz del Rio     (ODC Space)
   E.D. Wright         (JPL)

Version


   -Icy Version 1.0.3, 10-AUG-2021 (JDR)

       Edited the -Examples section to comply with NAIF standard.
       Modified code example to hardcode the input DAF file.

       Added -Parameters, -Exceptions, -Files, -Restrictions,
       -Literature_References and -Author_and_Institution sections.

       Removed reference to the routine's corresponding CSPICE header from
       -Abstract section.

       Added argument's type and size information in the -I/O section.

   -Icy Version 1.0.2, 11-NOV-2013 (EDW)

       Edits to -Examples text. Added -Particulars section text.

   -Icy Version 1.0.1, 08-AUG-2008 (EDW)

       Minor edits to header text.

   -Icy Version 1.0.0, 16-JUN-2003 (EDW)

Index_Entries


   close DAF



Fri Dec 31 18:43:02 2021