Table of contents
CSPICE_EKTNAM returns the name of a specified, loaded table.
Given:
n the scalar integer index of the table whose name is desired.
help, n
LONG = Scalar
The value of `n' ranges from 0 to the number of loaded tables
minus 1, which count may be obtained from cspice_ekntab.
the call:
cspice_ektnam, n, table
returns:
table the name of the n'th loaded table.
help, table
STRING = 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) Dump the names of all the loaded tables.
Use the meta-kernel shown below to load the required SPICE
kernels.
KPL/MK
File name: ektnam_ex1.tm
This meta-kernel is intended to support operation of SPICE
example programs. The kernels shown here should not be
assumed to contain adequate or correct versions of data
required by SPICE-based user applications.
In order for an application to use this meta-kernel, the
kernels referenced here must be present in the user's
current working directory.
The names and contents of the kernels referenced
by this meta-kernel are as follows:
File name Contents
--------- --------
S78_CIMSSSUPa.bep Cassini Science Plan #78
S79_CIMSSSUPa.bep Cassini Science Plan #79
S79_status_pf.bes Cassini Spacecraft Sequence
Status #79
\begindata
KERNELS_TO_LOAD = ( 'S78_CIMSSSUPa.bep',
'S79_CIMSSSUPa.bep',
'S79_status_pf.bes' )
\begintext
End of meta-kernel
Example code begins here.
PRO ektnam_ex1
;;
;; Local parameters.
;;
META = 'ektnam_ex1.tm'
;;
;; Load the EK files. Use a meta-kernel for convenience.
;;
cspice_furnsh, META
;;
;; Get the number of loaded tables. The count refers to the
;; number of logical tables; if multiple EKs contain data
;; for the same table, these EKs collectively contribute
;; only one table to the count.
;;
cspice_ekntab, ntab
print, format='(A,I3)', 'Number of tables in EK subsystem:', ntab
for tab=0L, ntab-1L do begin
;;
;; Get the name of the current table, and display it.
;;
cspice_ektnam, tab, tabnam
print, format='(2A)', ' TABLE = ', tabnam
endfor
END
When this program was executed on a Mac/Intel/IDL8.x/64-bit
platform, the output was:
Number of tables in EK subsystem: 4
TABLE = CASSINI_SP_REQUEST
TABLE = CASSINI_SP_OBSERVATION
TABLE = CASSINI_SP_REQ_OBS
TABLE = CASSINI_STATUS
This routine is a utility that provides the caller with the
name of a specified loaded table. The index of a table with
a given name depends on the kernels loaded and possibly on
the order in which the files have been loaded.
1) If this routine is called when no files are loaded, the error
SPICE(NOLOADEDFILES) is signaled by a routine in the call tree
of this routine.
2) If the input `n' is out of range, the error SPICE(INVALDINDEX)
is signaled by a routine in the call tree of this routine.
3) If the input argument `n' is undefined, an error is signaled
by the IDL error handling system.
4) If the input argument `n' is not of the expected type, or it
does not have the expected dimensions and size, an error is
signaled by the Icy interface.
5) If the output argument `table' is not a named variable, an
error is signaled by the Icy interface.
The returned name is based on the currently loaded EK files.
None.
EK.REQ
ICY.REQ
None.
J. Diaz del Rio (ODC Space)
E.D. Wright (JPL)
-Icy Version 1.0.1, 31-MAY-2021 (JDR)
Edited the header to comply with NAIF standard. Added complete
code example.
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 name of a loaded table
|