szpool_c

Index Page szpool_c
A B C D E F G H I J K L M N O P Q R S T U V W X
Procedure Abstract Required_Reading Keywords Brief_I/O Detailed_Input | Detailed_Output Parameters Exceptions Files Particulars Examples | Restrictions Literature_References Author_and_Institution Version Index_Entries
#### Procedure
       void szpool_c ( ConstSpiceChar * name,
                       SpiceInt       * n,
                       SpiceBoolean   * found )
#### Abstract
       Return the kernel pool size limitations.
#### Required_Reading
       KERNEL
#### Keywords
       CONSTANTS
       FILES
#### Brief_I/O
       VARIABLE  I/O  DESCRIPTION
       --------  ---  --------------------------------------------------
       name       I   Name of the parameter to be returned.
       n          O   Value of parameter specified by name.
       found      O   SPICETRUE if name is recognized.
#### Detailed_Input
       name       is the name of a kernel pool size parameter.
                  The following parameters may be specified:

                  MAXVAR      is the maximum number of variables that the
                              kernel pool may contain at any one time.
                              MAXVAR should be a prime number.

                  MAXLEN      is the maximum length of the variable names
                              that can be stored in the kernel pool.

                  MAXVAL      is the maximum number of distinct values that
                              may belong to the variables in the kernel
                              pool.  Each variable must have at least one
                              value, and may have any number, so long as
                              the total number does not exceed MAXVAL.
                              MAXVAL must be at least as large as MAXVAR.

                  MXNOTE      is the maximum number of distinct
                              variable-agents pairs that can be maintained
                              by the kernel pool.  (A variable is "paired"
                              with an agent, if that agent is to be
                              notified whenever the variable is updated.)

                  MAXAGT      is the maximum number of agents that can be
                              kept on the distribution list for
                              notification of updates to kernel variables.

                  MAXCHR      is the maximum number of characters that can
                              be stored in a component of a string valued
                              kernel variable.

                  MAXLIN      is the maximum number of character strings
                              that can be stored as data for kernel pool
                              variables.

                  Note that the case of name is insignificant.  Embedded
                  blanks are also ignored.
#### Detailed_Output
       n          is the value of the parameter specified by name.  If
                  name is not one of the items specified above, n will
                  be returned with the value 0.

       found      is SPICETRUE if the parameter is recognized and
                  SPICEFALSE if it is not.
#### Parameters
       None.
#### Exceptions
       1) If the specified parameter is not recognized, the value of
          n will be set to zero and found will be set to SPICEFALSE.
#### Files
       None.
#### Particulars
       This routine provides a programmatic interface to the parameters
       used to define the capacity limits of kernel pool.  It is not
       anticipated that most kernel pool users will need to use this
       routine.
#### Examples
       1)  The following code fragment demonstrates how to determine the
           size of a kernel reader parameter.

           #include <stdio.h>
           #include "SpiceUsr.h"

           void main () {

              /.
              Local Variables
              ./
              ConstSpiceChar    * varname = "MAXLEN";

              SpiceBoolean        found;

              SpiceInt            n;

              /.
              Make the call to retrieve the value of MAXLEN
              ./
              szpool_c ( varname, &n, &found );

              /.
              If MAXLEN parameter was found, print it out
              ./
              if ( found ) {
                 printf ( "Kernel parameter found.\n" );
                 printf ( "value:\t%s = %d\n", varname, n );
              }
           }
#### Restrictions
       None.
#### Literature_References
       None.
#### Author_and_Institution
       N.J. Bachman (JPL)
       W.L. Taber   (JPL)
       H.W. Taylor  (ACT)
#### Version
       -CSPICE Version 2.1.0, 02-SEP-1999 (NJB)

          Local type logical variable now used for found flag used in
          interface of szpool_.

       -CSPICE Version 1.0.0, 23-MAR-1999 (HWT)
#### Index_Entries
       return a kernel pool definition parameter
#### Link to routine szpool_c source file szpool_c.c

    Thu Apr 16 08:59:21 2009