Index Page
cspice_pipool
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_PIPOOL provides toolkit programmers a method for 
   programmatically inserting integer data into the kernel pool.

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

I/O

   
   Given:
   
      name    the scalar string name of the kernel pool variable to
              associate with the values supplied in the array 'ivals'.
              'name' is restricted to a length of 32 characters or less.

      ivals   an array of integers to load into the kernel pool
              sub-system with the assigned variable name 'name'.
   
   the call:
   
      cspice_pipool, name, ivals
   
   returns:

      Inserts the variable 'name' into the kernel pool with values as
      defined in 'ivals'.
   

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.

      ;;
      ;; Define array sizes and the kernel variable name.
      ;;
      PIPOOL_DIM =  9
      PIPOOL_VAR =  'pipool_array'
      NUM_VALS   = 50
      
      ;;
      ;; Create an array of longs, 0 to (POOL_DIM-1)
      ;;
      pipool_arr = lindgen( PIPOOL_DIM )   
      
      ;;
      ;; Insert the data assigned to 'PIPOOL_VAR' into the kernel pool.
      ;;
      cspice_pipool, PIPOOL_VAR, pipool_arr
      
      ;;
      ;; Retrieve the values associated to 'PIPOOL_VAR' into the
      ;; variable ivals. Retrieve all values, so set
      ;; 'START' to zero.
      ;;
      START = 0
      cspice_gipool, PIPOOL_VAR, START, NUM_VALS, ivals, found
   
      ;;
      ;; Check we found the expected variable, and ensure
      ;; the expected values.
      ;;
      if ( found ) then begin
      
         print, 'Found array variable ' + PIPOOL_VAR + ' with entries:'
   
         for i = 0, (n_elements(ivals)-1) do begin
            print, ivals[i]
         endfor
   
      endif else begin
         print, 'Variable ' + PIPOOL_VAR + ' not found in kernel pool.'
      endelse
   
   IDL outputs:
   
      Found array variable pipool_array with entries:
                 0
                 1
                 2
                 3
                 4
                 5
                 6
                 7
                 8

Particulars


   Kernel pool variable names are restricted to a length of 32 
   characters or less.

Required Reading


   ICY.REQ
   KERNEL.REQ

Version


   -Icy Version 1.0.1, 10-FEB-2010, EDW (JPL)

      Added mention of the length restriction on the kernel pool variable
      name 'name'.

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

Index_Entries

 
   Set the value of a numeric kernel pool variable 
 



Wed Apr  5 17:58:02 2017