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

Class DafHandleManager

java.lang.Object

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

public final class DafHandleManager
extends Object

This class is intended to provide low-level services for the creation, updating, and reading of direct access files utilized by the DAF and DAS systems within SPICE.
This class based on the zzddhman.for file in the SPICE library.

Since:

4.11

Author:

T0281925

Method Summary

Modifier and Type	Method and Description
static void	closeFile(int handle, String arch) Close the file associated with HANDLE. Based on the ZZDDHCLS routine from the SPICE library.
static String	getArchitectureFromHandle(int handle) Indicate the architecture of the file associated to handle. Inspired by ZZDDHNFO routine in the SPICE library.
static String	getBinaryFileFormatFromHandle(int handle) Indicate the binary file format of the file associated to handle. Inspired by ZZDDHNFO routine in the SPICE library.
static File	getFile(int handle) Return the File object associated with a handle. Inspired by ZZDDHHLU routine from the SPICE library.
static String	getFilename(int handle) Indicate the file name associated to a handle. Inspired by ZZDDHNFO routine in the SPICE library.
static boolean	getFound(int handle) Indicate if the handle is found in the list. Inspired by ZZDDHNFO routine in the SPICE library.
static int	getHandle(String fname) Retrieve handle associated with filename.
static int	openFile(String fname, String accessMethod, String archi) Load a new direct access file. This method is based on the ZZDDHOPN routine in the SPICE library

Methods inherited from class java.lang.Object

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

Method Detail

openFile

public static int openFile(String fname,
                           String accessMethod,
                           String archi)
                    throws IOException,
                           PatriusException

Load a new direct access file.
This method is based on the ZZDDHOPN routine in the SPICE library

Parameters:

fname - Name of file to be loaded

accessMethod - Access method used to load the file

archi - Expected architecture of the file to load

Returns:

handle assigned to file

Throws:

IOException - if there is a problem with the file

PatriusException - if there is a problem with the SPICE algorithm (including access method)

closeFile

public static void closeFile(int handle,
                             String arch)
                      throws PatriusException

Close the file associated with HANDLE.
Based on the ZZDDHCLS routine from the SPICE library.

Parameters:

handle - File handle associated with the file to close

arch - Expected architecture of the handle to close

Throws:

PatriusException - if the architecture does not correspond to the one saved

getFilename

public static String getFilename(int handle)

Indicate the file name associated to a handle.
Inspired by ZZDDHNFO routine in the SPICE library.

Parameters:

handle - File handle assigned to file of interest

Returns:

name of the file associated with HANDLE

getFound

public static boolean getFound(int handle)

Indicate if the handle is found in the list.
Inspired by ZZDDHNFO routine in the SPICE library.

Parameters:

handle - File handle assigned to file of interest

Returns:

boolean that indicates if handle was found

getBinaryFileFormatFromHandle

public static String getBinaryFileFormatFromHandle(int handle)

Indicate the binary file format of the file associated to handle.
Inspired by ZZDDHNFO routine in the SPICE library.

Parameters:

handle - File handle assigned to file of interest

Returns:

file's binary file format

getArchitectureFromHandle

public static String getArchitectureFromHandle(int handle)

Indicate the architecture of the file associated to handle.
Inspired by ZZDDHNFO routine in the SPICE library.

Parameters:

handle - File handle assigned to file of interest

Returns:

file's architecture

getHandle

public static int getHandle(String fname)
                     throws PatriusException

Retrieve handle associated with filename.

Parameters:

fname - Name of a file previously loaded

Returns:

the corresponding file handle (0 if it was not found)

Throws:

PatriusException - if the file is not found in the list

getFile

public static File getFile(int handle)

Return the File object associated with a handle.
Inspired by ZZDDHHLU routine from the SPICE library.

Parameters:

handle - Handle associated with the file of interest

Returns:

the corresponding File object