Procedure

   gipool_c (Get integers from the kernel pool) 

   void gipool_c ( ConstSpiceChar * name,
                   SpiceInt         start,
                   SpiceInt         room,
                   SpiceInt       * n,
                   SpiceInt       * ivals,
                   SpiceBoolean   * found )

Abstract

   Return the integer value of a kernel variable from the
   kernel pool.

Required_Reading

   KERNEL

Keywords

   CONSTANTS
   FILES

Brief_I/O

   VARIABLE  I/O  DESCRIPTION
   --------  ---  --------------------------------------------------
   name       I   Name of the variable whose value is to be returned.
   start      I   Which component to start retrieving for `name'
   room       I   The largest number of values to return.
   n          O   Number of values returned for `name'.
   ivals      O   Values associated with `name'.
   found      O   SPICETRUE if variable is in pool.

Detailed_Input

   name        is the name of the variable whose values are to be
               returned. If the variable is not in the pool with
               numeric type, `found' will be SPICEFALSE.

   start       is the index of the first component of `name' to return.
               The index follows the C convention of being 0 based.
               If `start' is less than 0, it will be treated as 0. If
               `start' is greater than the total number of components
               available for `name', no values will be returned (n will
               be set to zero).  However, `found' will still be set to
               SPICETRUE.

   room        is the maximum number of components that should be
               returned for this variable. (Usually it is the amount
               of room available in the array ivals). If `room' is
               less than 1 the error SPICE(BADARRAYSIZE) will be
               signaled.

Detailed_Output

   n           is the number of values associated with `name' that
               are returned. It will always be less than or equal
               to `room'.

               If `name' is not in the pool with numeric type, no value
               is given to `n'.

   ivals       is the array of values associated with `name'.
               If `name' doesn't match an existing kernel variable
               name, or if `name' matches the name of a non-numeric
               kernel variable, `ivals' is not updated.

               Non-integral values associated with `name' in the kernel
               pool are rounded to the nearest integer when they are
               copied to `ivals'.


   found       is SPICETRUE if the variable is in the pool and has
               numeric type, SPICEFALSE if it is not.

Parameters

   None.

Exceptions

   1)  If the value of `room' is less than one, the error
       SPICE(BADARRAYSIZE) is signaled by a routine in the call tree
       of this routine.

   2)  If a value requested is outside the valid range of integers,
       the error SPICE(INTOUTOFRANGE) is signaled by a routine in the
       call tree of this routine.

   3)  If the `name' input string pointer is null, the error
       SPICE(NULLPOINTER) is signaled.

   4)  If the `name' input string has zero length, the error
       SPICE(EMPTYSTRING) is signaled.

Files

   None.

Particulars

   This routine provides the user interface for retrieving
   integer data stored in the kernel pool. This interface
   allows you to retrieve the data associated with a variable
   in multiple accesses. Under some circumstances this alleviates
   the problem of having to know in advance the maximum amount
   of space needed to accommodate all kernel variables.

   However, this method of access does come with a price. It is
   always more efficient to retrieve all of the data associated
   with a kernel pool data in one call than it is to retrieve
   it in sections.

   See also the entry points gdpool_c and gcpool_c.

Examples

   The numerical results shown for this example may differ across
   platforms. The results depend on the SPICE kernels used as
   input, the compiler and supporting libraries, and the machine
   specific arithmetic implementation.

   1) The following code example demonstrates how the data stored
      in a kernel pool variable can be retrieved in pieces.

      Use the kernel shown below to load the kernel pool with the
      variables used within the example.


         KPL/MK

         File name: gipool_ex1.tm

         This kernel is intended to support operation of SPICE
         example programs.

         \begindata

            CTEST_VAL = ('LARRY', 'MOE', 'CURLY' )

            ITEST_VAL = ( 3141, 186, 282 )

            DTEST_VAL = ( 3.1415, 186. , 282.397 )

         \begintext

         End of meta-kernel


      Example code begins here.


      /.
         Program gipool_ex1
      ./
      #include <stdio.h>
      #include "SpiceUsr.h"

      int main()
      {
         /.
         Local parameters.
         ./
         #define NUMVALS 2

         /.
         Local variables.
         ./
         SpiceBoolean      found;

         SpiceInt          i;
         SpiceInt          ivals[NUMVALS];
         SpiceInt          n;

         /.
         Load the test data.
         ./
         furnsh_c ( "gipool_ex1.tm" );

         /.
         Is data available by that name?
         ./
         gipool_c ( "ITEST_VAL", 0, NUMVALS, &n, ivals, &found );

         /.
         If so, show me the values.
         ./
         if ( !found )
         {
            printf ( "No int data available for ITEST_VAL.\n" );
         }
         else
         {
            for ( i=0; i < NUMVALS; i++ )
            {
               printf ( "%d \n", ivals[i] );
            }
         }

         return ( 0 );
      }


      When this program was executed on a Mac/Intel/cc/64-bit
      platform, the output was:


      3141
      186

Restrictions

   None.

Literature_References

   None.

Author_and_Institution

   N.J. Bachman        (JPL)
   J. Diaz del Rio     (ODC Space)
   E.D. Wright         (JPL)

Version

   -CSPICE Version 2.1.2, 10-AUG-2021 (JDR)

       Edited the header to comply with NAIF standard.
       Removed unnecessary includes, replaced "ldpool_c" by
       "furnsh_c" and fixed bug in the code example.

   -CSPICE Version 2.1.1, 14-JUL-2014 (NJB)

       Updated description of the output array `ivals'.
       Made minor edits to header comments. Updated index entry.

   -CSPICE Version 2.1.0, 22-JUN-1999 (EDW)

       Re-implemented routine without dynamically allocated, temporary
       strings.

       Added local variable to return boolean/logical values. This
       fix allows the routine to function if int and long are different
       sizes.

   -CSPICE Version 2.0.1, 08-FEB-1998 (EDW)

       The start parameter is now zero based as per C convention.

   -CSPICE Version 1.0.1, 06-JAN-1998 (EDW)

       Replaced example routine. Included the data for a test kernel.

   -CSPICE Version 1.0.0, 25-OCT-1997 (EDW)

Index_Entries

   return the integer value of a pooled kernel variable
   return values of an integer_variable from the kernel_pool