Index Page
cspice_gipool
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_GIPOOL returns the value of an integer kernel
   variable (scalar or array) from the kernel pool.

I/O


   Given:

      name     name of a pool variable associated to integer values.

               [1,m] = size(name); char = class(name)

      start    value for the index indicating the first component of the data
               vector assigned to 'name' for return (index 1 for all
               elements).

               [1,1] = size(start); int32 = class(start)

      room     value specifying the maximum number of components that can
               return for 'name'.

               [1,1] = size(room); int32 = class(room)

   the call:

      [ivals, found] = cspice_gipool( name, start, room )

   returns:

      ivals   the representation of the integer values assigned to 'name'
              beginning at index 'start'. 'ivals' returns empty if the
              variable 'name' does not exist in the kernel pool.

              [n,1] = size(ivals); double = class(ivals)

              This function does not return double precision values from
              the kernel pool, rather double precision representations
              of integer values.

      found   the flag indicating true if 'name' exists in the kernel pool and
              has numeric type, false if it is not.

              [1,1] = size(found); logical = class(found)

              'ivals' has a size of 'room' or less (N<='room').

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 kernel containing the variable assignments:
      %
      %   CTEST_VAL = ('LARRY', 'MOE', 'CURLY' )
      %
      %   ITEST_VAL = ( 3141, 186, 282 )
      %
      %   DTEST_VAL = ( 3.1415, 186. , 282.397 )
      %
      cspice_furnsh( 'pool_t.ker' )

      %
      % Retrieve up-to 'ROOM' character entries for
      % kernel pool variable named 'ITEST_VAL' to
      % the array named 'cvals'. The first index to return,
      % 'START', has value 1 (this returns all components).
      %
      VAR    = 'ITEST_VAL';
      ROOM   = 25;
      START  = 1;

      %
      % cspice_gipool returns an empty array if the variable
      % does not exist in the kernel pool.
      %
      [ivals, found] = cspice_gipool( VAR, START, ROOM );

      if ( found )

         txt = sprintf( 'Found %s in the kernel pool', VAR );
         disp(txt)

         n_elements = size( ivals, 1);

         %
         % Retrieve the number of elements returned in 'ivals' from the
         % second element returned from "size".
         %
         for n=1:n_elements
            txt = sprintf( '   Element %d of %s: %i', i, VAR, ivals(n) );
            disp(txt)
         end

      else

         txt = sprintf( 'Failed to find %s in the kernel pool', VAR );
         disp(txt)

      end

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

   MATLAB outputs:

      Found ITEST_VAL in the kernel pool
         Element 1 of ITEST_VAL: 3141
         Element 2 of ITEST_VAL: 186
         Element 3 of ITEST_VAL: 282

Particulars


   None.

Required Reading


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

   MICE.REQ
   KERNEL.REQ

Version


   -Mice Version 1.2.0, 12-MAR-2012, EDW (JPL), SCK (JPL)

      "logical" call replaced with "zzmice_logical."

      I/O descriptions edits to conform to Mice documentation format.

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

Index_Entries


   RETURN the integer value of a pooled kernel variable


Wed Apr  5 18:00:32 2017