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

Abstract
I/O
Examples
Particulars
Required Reading
Version
Index_Entries

Abstract


   CSPICE_DAFDC deletes the entire comment area of a specified DAF file.

I/O


   Given:

      handle   the file handle referring to a DAF file opened with
               write access. This handle refers to the DAF file from which
               to delete the comment section.

               [1,1] = size(handle); int32 = class(handle)

   the call:

      cspice_dafdc( handle )

   removes the comment area of the DAF file referred to by 'handle'.

   returns:

      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.

      %
      %    Given an SPK with a comment section:
      %
      %      Body list
      %       1 MERCURY BARYCENTER
      %       2 VENUS BARYCENTER
      %       3 EARTH BARYCENTER
      %       4 MARS BARYCENTER
      %       5 JUPITER BARYCENTER
      %       6 SATURN BARYCENTER
      %       7 URANUS BARYCENTER
      %       8 NEPTUNE BARYCENTER
      %
      %             ...

      %
      % Define the SPK file from which to remove the comments section.
      %
      SPK = 'test.spk';

      %
      % Open for writing the 'SPK', return the corresponding
      % file handle to 'handle'.
      %
      handle = cspice_dafopw( SPK );

      %
      % Remove the comment section from the DAF referred to by 'handle'.
      %
      cspice_dafdc( handle )

      %
      % SAFELY close the file.
      %
      cspice_dafcls( handle )

   Examine the 'SPK' comment after the cspice_dafdc call.

      $ commnt -r test.spk

      There were no comments in the file 'test.spk'.

   Matlab outputs:

      None.

Particulars


   A binary DAF contains an area which is reserved for storing
   annotations or descriptive textual information about the data
   contained in a file. This area is referred to as the ``comment
   area'' of the file. The comment area of a DAF is a line oriented
   medium for storing textual information. The comment area preserves
   any leading or embedded white space in the line(s) of text which are
   stored, so that the appearance of the of information will be
   unchanged when it is retrieved (extracted) at some other time.
   Trailing blanks, however, are NOT preserved, due to the way that
   character strings are represented in standard Fortran 77.

   This routine will delete the entire comment area from the binary DAF
   attached to `handle'. The size of the binary DAF will remain
   unchanged. The space that was used by the comment records is
   reclaimed:  the data area of the DAF is shifted toward the beginning

Required Reading


   For important details concerning this module's function, please refer to
   the CSPICE routine dafdc_c.

   MICE.REQ
   DAF.REQ

Version


   -Mice Version 1.0.0, 10-JUL-2012, EDW (JPL)

Index_Entries


    delete DAF comment area


Wed Apr  5 18:00:30 2017