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

Class DafHandle

java.lang.Object

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

public final class DafHandle
extends Object

This class is and adaptation of one part of the dafah.for file of the SPICE library.

This class has as objective to manage DAF files by their handle. This includes opening, closing and retrieving information about the summary.

Several files may be opened for use simultaneously. (This makes it convenient to combine data from several files to produce a single result.) As each DAF is opened, it is assigned a file handle, which is used to keep track of the file internally, and which is used by the calling program to refer to the file in all subsequent calls to DAF methods.

Currently DAF files can only be opened for read purposes. Writing in a DAF or creating a DAF file is not implemented.

Since:

4.11

Author:

T0281925

Method Summary

Modifier and Type	Method and Description
static void	checkHandleAccess(int handle, String access) Signal an error if a DAF file handle does not designate a DAF that is open for a specified type of access. Based on DAFSIH from the SPICE library.
static void	closeDAF(int handle) Close the DAF associated with a given handle. Based on DAFCLS from the SPICE library.
static List<Integer>	getHandleList() Return a SPICE set containing the handles of all currently open DAFS. Based on DAFHOF from the SPICE library.
static int[]	getSummaryFormatDAF(int handle) Return the summary format associated with a handle. Based on DAFHSF from the SPICE library.
static String	handleToFilenameDAF(int handle) Return the name of the file associated with a handle. Based on DAFHFN from the SPICE library.
static boolean	isLoaded(String file, int[] handle) Check if a file is already loaded in the DAF Handle structure.
static int	openReadDAF(String filename) Open a DAF for subsequent read requests. Based on DAFOPR from the SPICE library.

Methods inherited from class java.lang.Object

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

Method Detail

openReadDAF

public static int openReadDAF(String filename)
                       throws IOException,
                              PatriusException

Open a DAF for subsequent read requests.
Based on DAFOPR from the SPICE library.

Parameters:

filename - Name of DAF to be opened

Returns:

handle assigned to DAF

Throws:

IOException - if there is a problem opening, reading or closing the file

PatriusException - if there is a problem related with the SPICE algorithm

closeDAF

public static void closeDAF(int handle)
                     throws PatriusException

Close the DAF associated with a given handle.
Based on DAFCLS from the SPICE library.

Parameters:

handle - Handle of DAF to be closed.

Throws:

PatriusException - if there is a problem in the HandleManager closing the file

getSummaryFormatDAF

public static int[] getSummaryFormatDAF(int handle)
                                 throws PatriusException

Return the summary format associated with a handle.
Based on DAFHSF from the SPICE library.

Parameters:

handle - Handle of a DAF file.

Returns:

int array containing the number of double precision (first element) and integer (second element) components in summaries

Throws:

PatriusException - if the file wasn't opened beforehand

handleToFilenameDAF

public static String handleToFilenameDAF(int handle)
                                  throws PatriusException

Return the name of the file associated with a handle.
Based on DAFHFN from the SPICE library.

Parameters:

handle - Handle of a DAF file

Returns:

the corresponding file name

Throws:

PatriusException - if the filename in the HandleManager is empty

isLoaded

public static boolean isLoaded(String file,
                               int[] handle)
                        throws PatriusException

Check if a file is already loaded in the DAF Handle structure.

Parameters:

file - Path to the file we are interested in

handle - (out) contains the handle associated to the file if it was loaded

Returns:

a boolean indicating if the file has already been been loaded

Throws:

PatriusException - if there is a problem retrieving the information.

getHandleList

public static List<Integer> getHandleList()

Return a SPICE set containing the handles of all currently open DAFS.
Based on DAFHOF from the SPICE library.

Returns:

the list of handles associated to opened DAF files

checkHandleAccess

public static void checkHandleAccess(int handle,
                                     String access)
                              throws PatriusException

Signal an error if a DAF file handle does not designate a DAF that is open for a specified type of access.
Based on DAFSIH from the SPICE library.

Parameters:

handle - HANDLE to be validated

access - String indicating access type

Throws:

PatriusException - if the access is not correct or the handle not found in the list