CSPICE_SZPOOL returns kernel pool size parameters.
For important details concerning this module's function, please refer to
the CSPICE routine szpool_c.
Given:
name the scalar string name of the parameter to return, possible
values:
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
variableagents 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.
the call:
cspice_szpool, name, n, found
returns:
n the value of the parameter indicated by 'name'
found a boolean indicating whether the kernel pool
recognizes parameter 'name' (TRUE) or not
(FALSE)
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.
;;
;; 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
IDL outputs:
Toolkit version: CSPICE_N0056
Parameter MAXVAR has value 5003
Parameter MAXLEN has value 32
Parameter MAXVAL has value 40000
Parameter MXNOTE has value 2000
Parameter MAXAGT has value 1000
Parameter MAXCHR has value 80
Parameter MAXLIN has value 4000
No size parameter named EVERLASTING_GOBSTOPPER
None.
ICY.REQ
KERNEL.REQ
Icy Version 1.0.0, 16JUN2003, EDW (JPL)
return a kernel pool definition parameter
