Index Page
cspice_clpool
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_CLPOOL clears the kernel pool.

I/O


   The call:

      cspice_clpool

   deletes all variable assignments loaded into the kernel
   pool.

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.

      %
      % Place a value into the kernel pool. Recall
      % the routines for direct insertion
      % of pool assignments have arrays for input,
      % but in MATLAB a scalar is a 1x1 array.
      %
      cspice_pdpool( 'TEST_VAR', -666. )

      %
      % Check for the variable assignment to TEST_VAR.
      % cspice_gdpool returns an empty array if the variable
      % does not exist in the kernel pool.
      %
      dvals = cspice_gdpool( 'TEST_VAR', 0, 1 );

      if ( ~isempty(dvals) )
         disp( sprintf( 'TEST_VAR value: %f', dvals ) )
      end

      %
      % Now clear the kernel pool.
      %
      cspice_clpool

      %
      % Again, check for the TEST_VAR assignment.
      %
      dvals = cspice_gdpool( 'TEST_VAR', 0, 1 );

      if ( isempty(dvals)  )
         disp( 'TEST_VAR not in kernel pool' )
      end

   MATLAB outputs, after the first cspice_gdpool call:

      TEST_VAR value: -666.000000

   Demonstrating the existence of the assignment on the
   kernel pool.

   MATLAB outputs, after the second cspice_gdpool call:

      TEST_VAR not in kernel pool

   The variable assignment no longer exists in the kernel pool.

Particulars


   Note, cspice_clpool deletes ALL pool assignments, including those
   from cspice_boddef and the cspice_pipool, cspice_pdpool, cspice_pcpool
   set. Use cspice_unload to remove the assignments loaded from a
   particular kernel.

Required Reading


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

   MICE.REQ
   KERNEL.REQ

Version


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

Index_Entries


   CLEAR the pool of kernel variables


Wed Apr  5 18:00:30 2017