Index of Functions: A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X 
Index Page
szpool

Table of contents
Procedure
Abstract
Required_Reading
Keywords
Declarations
Brief_I/O
Detailed_Input
Detailed_Output
Parameters
Exceptions
Files
Particulars
Examples
Restrictions
Literature_References
Author_and_Institution
Version

Procedure

     SZPOOL (Get size limitations of the kernel pool)

     ENTRY SZPOOL ( NAME, N, FOUND )

Abstract

     Return the kernel pool size limitations.

Required_Reading

     KERNEL

Keywords

     CONSTANTS
     FILES

Declarations

    CHARACTER*(*)         NAME
    INTEGER               N
    LOGICAL               FOUND

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   .TRUE. 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.

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 .TRUE. if the parameter is recognized .FALSE. if it
              is not.

Parameters

     None.

Exceptions

     1)  If the specified parameter is not recognized, the value of N
         returned will be zero and FOUND will be set to .FALSE.

Files

     None.

Particulars

     This routine provides the a programmatic interface to the
     parameters used to define the kernel pool. It is not
     anticipated that most kernel pool users will need to use this
     routine.

Examples

     None.

Restrictions

     None.

Literature_References

     None.

Author_and_Institution

     J. Diaz del Rio    (ODC Space)
     W.L. Taber         (JPL)

Version

    SPICELIB Version 1.0.1, 17-AUG-2021 (JDR)

        Edited the header to comply with NAIF standard. Updated NAME
        description to not refer to the main routine.

    SPICELIB Version 1.0.0, 04-JUN-1999 (WLT)

        Added the entry points PCPOOL, PDPOOL and PIPOOL to allow
        direct insertion of data into the kernel pool without having
        to read an external file.

        Added the interface LMPOOL that allows SPICE
        programs to load text kernels directly from memory
        instead of requiring a text file.

        Added the entry point SZPOOL to return kernel pool definition
        parameters.

        Added the entry point DVPOOL to allow the removal of a variable
        from the kernel pool.

        Added the entry point GNPOOL to allow users to determine
        variables that are present in the kernel pool
Fri Dec 31 18:37:01 2021