Index Page
cspice_kinfo
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_KINFO returns information about a loaded kernel
   specified by name.

I/O


   Given:

      file   the name of a kernel file for which descriptive
             information is desired.

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

                or

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

   the call:

      [ filtyp, source, handle, found] = cspice_kinfo( file)

   returns:

      filtyp   the type name of the kernel specified by 'file'.
               'filtyp' will be empty if file is not on the list of kernels
               loaded via cspice_furnsh.

               [1,c2] = size(file); char = class(file)

      source   the name of the source file used to
               specify 'file' as one to load.  If 'file' was loaded
               directly via a call to cspice_furnsh, 'source' will be empty.
               If file is not on the list of kernels loaded via
               cspice_furnsh, 'source' will be empty.

               [1,c3] = size(file); char = class(file)

      handle   the integer handle attached to 'file' if it is a binary
               kernel.  If file is a text kernel or meta-text kernel
               handle will be zero. If file is not on the list of
               kernels loaded via cspice_furnsh, 'handle' has value zero.

               [1,1] = size(handle); int32 = class(handle)

      found    returns true if the specified file exists.
               If there is no such file, 'found' will be set to
               false.

               [1,1] = size(found); logical = class(found)

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.

      Use the meta-kernel shown below to load the required SPICE
      kernels.

         KPL/MK

         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
            ---------                     --------
            de421.bsp                     Planetary ephemeris
            pck00009.tpc                  Planet orientation and
                                          radii
            naif0009.tls                  Leapseconds


         \begindata

            KERNELS_TO_LOAD = ( '/kernels/gen/lsk/naif0009.tls'
                                '/kernels/gen/spk/de421.bsp'
                                '/kernels/gen/pck/pck00009.tpc'
                      )

         \begintext

      %
      % Load a meta kernel listing a path to an SPK file.
      %
      cspice_kclear
      cspice_furnsh( 'standard.tm' )

      %
      % Use cspice_kinfo to ensure the kernel system loaded
      % the SPK file of interest.
      %
      file = '/kernels/gen/spk/de421.bsp';

      [ filtyp, source, handle, found ] = cspice_kinfo( file );

      %
      % Take appropriate action depending on the returned
      % state of found. If found has value false, then
      % 'file' is not loaded.
      %
      if ( found )
         disp( [ 'File type: ' filtyp ] )
         disp( [ 'Source   : ' source ] )
      else
         disp( [ 'Kernel not loaded: ' file ] )
      end

      %
      % It's always good form to unload kernels after use,
      % particularly in Mice due to data persistence.
      %
      cspice_kclear

   MATLAB outputs:

      File type: SPK
      Source   : standard.tm

Particulars


   None.

Required Reading


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

   MICE.REQ
   DSK.REQ

Version


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

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

   -Mice Version 1.2.0, 10-MAY-2011, EDW (JPL)

      "logical" call replaced with "zzmice_logical."

   -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


   Fetch information about a loaded SPICE kernel


Wed Apr  5 18:00:33 2017