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

Abstract
I/O
Examples
Particulars
Required Reading
Version
Index_Entries

Abstract


   CSPICE_KTOTAL returns the current number of kernels loaded
   via the KEEPER interface that are of a specified type.

I/O


   Given:

     kind   a list of types of kernels to count when checking the
            loaded kernels. 

            [1,c1] = size(kind); char = class(kind)

               or

            [1,1] = size(kind); cell = class(kind)

            'kind' should consist of a list of words of kernels to 
            examine.  Recognized types are

                 'SPK'  --- All SPK files are counted in the total.
                 'CK'   --- All CK files are counted in the total. 
                 'PCK'  --- All binary PCK files are counted in the 
                          total. 
                 'DSK'  --- All DSK files are counted in the total. 
                 'EK'   --- All EK files are counted in the total. 
                 'TEXT' --- All text kernels that are not meta-text. 
                          kernels are included in the total. 
                 'META' --- All meta-text kernels are counted in the 
                          total. 
                 'ALL'  --- Every type of kernel is counted in the 
                          total. 

            'kind' lacks case sensitivity. The cspice_ktotal algorithm ignores
            words in 'kind' if not one of those listed above.

            See the Examples section for illustrations of the
            use of kind.

   the call:

      count = cspice_ktotal( kind )

   returns:

      count   the number of kernels loaded through cspice_furnsh 
              belonging to the list specified by 'kind'.

              [1,1] = size(count); double = class(count)

Examples


   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.

     %
     % Load the standard meta kernel, retrieve the number of
     % loaded kernels.
     %
     cspice_furnsh( 'standard.tm' )

     n   = cspice_ktotal( 'ALL' );
     txt = sprintf('Count of loaded kernels before cspice_kclear call: %d', n);
     disp( txt )

   MATLAB outputs:

     Count of loaded kernels before cspice_kclear call: 4

   The expected result counting standard.tm and the three kernels
   named in the meta kernel.

     %
     % Clear the KEEPER system, retrieve the number of loaded
     % after the clear.
     %
     cspice_kclear

     n   = cspice_ktotal( 'ALL' );
     txt = sprintf('Count of loaded kernels after cspice_kclear call: %d', n);
     disp( txt )

   MATLAB outputs:

     Count of loaded kernels after cspice_kclear call: 0

Particulars


   None.

Required Reading


   For important details concerning this module's function, please refer to
   the CSPICE routine ktotal_c.

   MICE.REQ
   DSK.REQ

Version


   -Mice Version 2.0.0, 20-JAN-2016, EDW (JPL), NJB (JPL)

       Header update to reflect support for use of DSKs. Corrected
       class type description for output argument `count', to double.

   -Mice Version 1.0.2, 01-DEC-2014, EDW (JPL)

       Edited I/O section to conform to NAIF standard for Mice documentation.

   -Mice Version 1.0.1, 06-MAY-2009, EDW (JPL)

       Added MICE.REQ reference to the Required Reading section.

   -Mice Version 1.0.0, 01-DEC-2006, EDW (JPL)

Index_Entries


   Number of loaded kernels of a given type


Wed Apr  5 18:00:33 2017