Table of contents
CSPICE_SZPOOL returns kernel pool size parameters.
Given:
name the name of a kernel pool size parameter.
help, name
STRING = Scalar
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.
the call:
cspice_szpool, name, n, found
returns:
n the value of the parameter specified by `name'.
help, n
LONG = Scalar
If `name' is not one of the items specified above, `n' will be
returned with the value 0.
found True if the parameter is recognized False if it is not.
help, found
BOOLEAN = Scalar
None.
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.
1) Output the values of the different kernel pool size
parameters. Request as well a non-existing parameter.
Example code begins here.
PRO szpool_ex1
;;
;; Define an array of size parameter names.
;;
NAMES = [ "MAXVAR", $
"MAXLEN", $
"MAXVAL", $
"MXNOTE", $
"MAXAGT", $
"MAXCHR", $
"MAXLIN", $
"EVERLASTING_GOBSTOPPER" ]
;;
;; Show the toolkit version.
;;
print, "Toolkit version: ", cspice_tkvrsn('toolkit')
print
;;
;; Loop over the parameter list, checking for a corresponding
;; value.
;;
for i = 0, n_elements(NAMES)-1 do begin
;;
;; Make the call, check for a 'found'
;;
cspice_szpool, NAMES[i], value, found
;;
;; Output the returned value or indicate a failure.
;;
if (found) then begin
print, "Parameter " + NAMES[i] + " has value " + string(value)
endif else begin
print
print, "No size parameter named " + NAMES[i]
endelse
endfor
END
When this program was executed on a Mac/Intel/IDL8.x/64-bit
platform, the output was:
Toolkit version: CSPICE_N0066
Parameter MAXVAR has value 26003
Parameter MAXLEN has value 32
Parameter MAXVAL has value 400000
Parameter MXNOTE has value 130015
Parameter MAXAGT has value 1000
Parameter MAXCHR has value 80
Parameter MAXLIN has value 15000
No size parameter named EVERLASTING_GOBSTOPPER
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.
1) If the specified parameter is not recognized, the value of `n'
returned will be zero and `found' will be set to False.
2) If the input argument `name' is undefined, an error is
signaled by the IDL error handling system.
3) If the input argument `name' is not of the expected type, or
it does not have the expected dimensions and size, an error is
signaled by the Icy interface.
4) If any of the output arguments, `n' or `found', is not a named
variable, an error is signaled by the Icy interface.
None.
None.
ICY.REQ
KERNEL.REQ
None.
J. Diaz del Rio (ODC Space)
E.D. Wright (JPL)
-Icy Version 1.0.1, 01-JUN-2021 (JDR)
Edited the header to comply with NAIF standard. Added example's
problem statement and reformatted example's output.
Added -Parameters, -Exceptions, -Files, -Restrictions,
-Literature_References and -Author_and_Institution sections, and
completed -Particulars section.
Removed reference to the routine's corresponding CSPICE header from
-Abstract section.
Added arguments' type and size information in the -I/O section.
-Icy Version 1.0.0, 16-JUN-2003 (EDW)
return a kernel pool definition parameter
|