Index Page
cspice_unload
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_UNLOAD unloads a SPICE kernel file (of any type)
   from MATLAB.

I/O


   Given:

      file   the SPICE kernel file name(s, 'file' (or any kernel listed
             in 'file') should be one loaded through the interface
             cspice_furnsh

             [n,c1] = size(file); char = class(file)

                or

             [1,n] = size(file); cell = class(file)

   the call:

      cspice_unload( file )

      removes the file and all associated data from the kernel
      sub-system. If file is a meta-text kernel, the sub-system
      unloads all files listed in the kernel.

      Note: a cspice_unload call deletes ALL kernel variables except
      those loaded into the kernel pool via a cspice_furnsh kernel
      load  call, i.e. cspice_unload erases kernel variables placed
      in the pool by the pool functions: cspice_pipool, cspice_pdpool,
      and cspice_pcpool.

   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.

      %
      %  Load a set of kernels: an SPK file, a PCK
      %  file and a leapseconds file. Use a meta
      %  kernel for convenience.
      %
      cspice_furnsh( 'standard.tm' )

      %
      % When the kernel variable
      %
      %    BODY399_RADII
      %
      % is present in the kernel pool---normally because a PCK
      % defining this variable has been loaded (as is the case
      % here)---the call
      %
      try
         values = cspice_bodvrd( 'EARTH', 'RADII', 3);
         disp('Expected result, found kernel data')
      catch
         disp('ERROR: Unexpected result, no kernel data found')
      end

      %
      %  Now unload the kernel and try again.
      %
      cspice_unload( 'standard.tm' )

      try
         values = cspice_bodvrd( 'EARTH', 'RADII', 3);
         disp('ERROR: Unexpected result, found kernel data')
      catch
         disp('Expected result, no kernel data found')
      end

Particulars


   None.

Required Reading


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

   MICE.REQ
   KERNEL.REQ
   PCK.REQ

Version


   -Mice Version 1.1.1, 13-FEB-2015, EDW (JPL)

       Edited I/O section to conform to NAIF standard for Mice documentation.

   -Mice Version 1.1.0, 17-DEC-2008, EDW (JPL)

       Added zzmice_str call on input 'file' to convert string cells to
       character arrays if 'file' has type string cells. Properly
       identified 'file' as a vectorizable string/character array.

   -Mice Version 1.0.0, 22-NOV-2005, EDW (JPL)

Index_Entries


   Unload a SPICE kernel


Wed Apr  5 18:00:36 2017