fr.cnes.sirius.patrius.bodies.bsp.spice

Class SpiceKernelManager

java.lang.Object

fr.cnes.sirius.patrius.bodies.bsp.spice.SpiceKernelManager

public final class SpiceKernelManager
extends Object

This class goal is to manage the loading and unloading of SPICE kernels from other PATRIUS methods.

It is based on the keeper.for file in the SPICE library.

Since:

4.11

Author:

T0281925

Method Summary

Modifier and Type	Method and Description
static void	clearAllKernels() Clear the SpiceKernelManager subsystem: unload all kernels, clear the kernel pool, and re-initialize the subsystem.
static void	getArchAndType(File file) Determine the architecture and type of SPICE kernels.
static void	loadSpiceKernel(String file) Load one or more SPICE kernels into a program.
static int	totalNumberOfKernel(String type) Return the number of kernels of a specified type that are currently loaded via the loadSpiceKernel interface.
static void	unloadKernel(String file) This interface allows you to unload binary kernels.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

loadSpiceKernel

public static void loadSpiceKernel(String file)
                            throws PatriusException,
                                   IOException

Load one or more SPICE kernels into a program.

Based on the FURNSH routine of the SPICE library.

Parameters:

file - SPICE kernel file (for now, only binary DAF files are allowed)

Throws:

PatriusException - if there is any file loading or pool problem

IOException - if there is any file loading problem

totalNumberOfKernel

public static int totalNumberOfKernel(String type)

Return the number of kernels of a specified type that are currently loaded via the loadSpiceKernel interface.

Based on the KTOTAL routine from the SPICE library

Parameters:

type - a kernel type (actually only SPK is allowed. add other types)

Returns:

the number of kernels of type TYPE

clearAllKernels

public static void clearAllKernels()
                            throws PatriusException

Clear the SpiceKernelManager subsystem: unload all kernels, clear the kernel pool, and re-initialize the subsystem. Existing watches on kernel variables are retained.

Based on the KCLEAR routine of the SPICE library

Throws:

PatriusException - if there is a problem unloading a file

unloadKernel

public static void unloadKernel(String file)
                         throws IOException,
                                PatriusException

This interface allows you to unload binary kernels.

The usual usage of loadSpiceKernel is to load each file needed by your program exactly one time. However, it is possible to load a kernel more than one time. The effect of unloading a kernel that has been loaded more than once is to "undo" the last loading of the kernel.

This method is based on the UNLOAD method from the SPICE library.

Parameters:

file - path of the file to be unload from the system

Throws:

IOException - if there is any problem unloading or loading a file

PatriusException - if there is any problem unloading or loading a file

getArchAndType

public static void getArchAndType(File file)
                           throws PatriusException,
                                  IOException

Determine the architecture and type of SPICE kernels.

Based on the GETFAT routine of the SPICE library.

Parameters:

file - The name of a file to be examined

Throws:

PatriusException - if there is a problem managing the file or the type is not SPK extend to other types

IOException - if there is a problem managing the file (open/read/close)