Index Page
cspice_dtpool
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_DTPOOL queries the kernel pool for the existence of a kernel
   variable, if found, the routine returns the size and type of
   pool variable.

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

I/O


   Given:

      name   the scalar string name of a pool variable

   the call:

      cspice_dtpool, name, found, n, type

   returns:

      found   a scalar boolean that returns TRUE if variable 'name'
              exists in the pool

      n       the integer count of values assigned to 'name', note a value
              greater than one indicates an array

      type    a character marker indicating the type of values
              assigned to 'name':

                 'C'   character values (strings)
                 'N'   numerical values (integers or doubles)
                 'X'   variable name does not exist in 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.

      Use the meta-kernel shown below to load the required SPICE
      kernels.

         KPL/MK

         File name: standard.tm

         This meta-kernel is intended to support operation of SPICE
         example programs. The kernels shown here should not be
         assumed to contain adequate or correct versions of data
         required by SPICE-based user applications.

         In order for an application to use this meta-kernel, the
         kernels referenced here must be present in the user's
         current working directory.

         The names and contents of the kernels referenced
         by this meta-kernel are as follows:

            File name                     Contents
            ---------                     --------
            de421.bsp                     Planetary ephemeris
            pck00009.tpc                  Planet orientation and
                                          radii
            naif0009.tls                  Leapseconds

         \begindata

            KERNELS_TO_LOAD = ( 'de421.bsp',
                                'pck00009.tpc',
                                'naif0009.tls'  )

         \begintext

   Example:

      ;;
      ;; Load a leapsecond kernel.
      ;;
      cspice_furnsh, 'standard.ker'

      ;;
      ;; Check for the variables defined in the leapseconds kernel.
      ;;
      lmpoolNames  = [                       $
                    "DELTET/DELTA_T_A",      $
                    "DELTET/K",              $
                    "DELTET/EB",             $
                    "DELTET/M",              $
                    "DELTET/DELTA_AT",       $
                    "EVERLASTING_GOBSTOPPER" $
                     ]

      for i = 0, n_elements(lmpoolNames)-1 do begin

         cspice_dtpool, lmpoolNames[i], found, n, dtype

         if (found) then begin
            print, "Variable name : " + lmpoolNames[i]
            print, "Variable size : " + string(n)
            print, "Variable type : " + dtype
            print
         endif else begin
            print, "Unable to find variable name : " + lmpoolNames[i]
            print
        endelse

      endfor

      ;;
      ;; It's always good form to unload kernels after use,
      ;; particularly in IDL due to data persistence.
      ;;
      cspice_kclear

   IDL outputs:

      Variable name : DELTET/DELTA_T_A
      Variable size :            1
      Variable type : N

      Variable name : DELTET/K
      Variable size :            1
      Variable type : N

      Variable name : DELTET/EB
      Variable size :            1
      Variable type : N

      Variable name : DELTET/M
      Variable size :            2
      Variable type : N

      Variable name : DELTET/DELTA_AT
      Variable size :           46
      Variable type : N

      Unable to find variable name : EVERLASTING_GOBSTOPPER


Particulars


   None.

Required Reading


   ICY.REQ
   KERNEL.REQ

Version


   -Icy Version 1.0.1, 05-JAN-2012, EDW (JPL)

      Edits to Example section, proper description of "standard.tm"
      meta kernel.

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

Index_Entries


   return summary information about a kernel pool variable




Wed Apr  5 17:58:00 2017