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.

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

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.
   
      ;;
      ;; Set the false flag.
      ;;
      SPICEFALSE = 0
   
      ;;
      ;; Place a value into the kernel pool. Recall
      ;; the routines for direct insertion
      ;; of pool assignments have arrays for input
      ;; so use a single value array to pass a scalar.
      ;;
      cspice_pdpool, 'TEST_VAR', [-666.d]
   
      ;;
      ;; Check for the variable assignment to TEST_VAR
      ;;
      cspice_gdpool, 'TEST_VAR', 0, 1, dval, found
   
      if ( found ) then begin
         print, 'TEST_VAR value: ', dval
      endif
   
      ;;
      ;; Now clear the kernel pool.
      ;;
      cspice_clpool 
   
      ;;
      ;; Again, check for the TEST_VAR assignment.
      ;;
      found = SPICEFALSE
      cspice_gdpool, 'TEST_VAR', 0, 1, dval, found
   
      if ( ~found ) then begin
         print, 'TEST_VAR not in kernel pool'
      endif
   
   IDL outputs, after the first cspice_gdpool call:
   
      TEST_VAR value:   -666.00000
   
   Demonstrating the existence of the assignment on the
   kernel pool.
   
   IDL 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


   ICY.REQ
   KERNEL.REQ

Version


   -Icy Version 1.0.1, 12-JUN-2006, EDW (JPL)

      Minor edit to header, placed note concerning cspice_clpool
      behavior in the particulars section.

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

Index_Entries

 
   CLEAR the pool of kernel variables 
 



Wed Apr  5 17:57:59 2017