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

Class FindArraysDAF

java.lang.Object

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

public final class FindArraysDAF
extends Object

Class for the search of arrays inside a DAF file.
The main function of these methods is to allow the contents of any DAF to be examined on an array-by-array basis.

Conceptually, the arrays in a DAF form a doubly linked list, which can be searched in either of two directions: forward or backward. It is possible to search multiple DAFs simultaneously.

Based on various routines of the daffa.for file in the SPICE library.

Since:

4.11

Author:

T0281925

Method Summary

Modifier and Type	Method and Description
static void	beginBackwardSearch(int handle) Begin a backward search for arrays in a DAF.
static void	beginForwardSearch(int handle) Begin forward search for arrays in a DAF.
static boolean	findNextArray() Find the next (forward) array in the current DAF.
static boolean	findPreviousArray() Find the previous (backward) array in the current DAF.
static String	getNameOfArray() Return (get) the name for the current array in the current DAF.
static double[]	getSummaryOfArray() Return (get) the summary for the current array in the current DAF.
static String	readCharacterRecordDaf(int handle, int record) Read the contents of a character record from a DAF.
static void	selectDaf(int handle) Select a DAF that already has a search in progress as the one to continue searching.

Methods inherited from class java.lang.Object

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

Method Detail

beginForwardSearch

public static void beginForwardSearch(int handle)
                               throws PatriusException

Begin forward search for arrays in a DAF.
Based on DAFBFS from the SPICE library.

Parameters:

handle - Handle of file to be searched

Throws:

PatriusException - if there is a problem with the SPICE algorithm

IOException - if there is a problem reading the first record of the file

beginBackwardSearch

public static void beginBackwardSearch(int handle)
                                throws PatriusException

Begin a backward search for arrays in a DAF.
This method is based on the DAFBBS routine from the SPICE library.

Parameters:

handle - Handle of DAF to be searched

Throws:

PatriusException - if there is a problem finding the file or reading it

IOException - if there is a problem opening the random access file

selectDaf

public static void selectDaf(int handle)
                      throws PatriusException

Select a DAF that already has a search in progress as the one to continue searching.
Based on the DAFCS routine of the SPICE library

Parameters:

handle - Handle of DAF to continue searching

Throws:

PatriusException - if the access mode is not correct or the DAF associated to the handle is not being searched

findNextArray

public static boolean findNextArray()
                             throws PatriusException

Find the next (forward) array in the current DAF.
Based on DAFFNA from the SPICE library.

Returns:

if the next array is found

Throws:

PatriusException - if there is a problem in the SPICE algorithm

findPreviousArray

public static boolean findPreviousArray()
                                 throws PatriusException

Find the previous (backward) array in the current DAF.
This method is based on the DAFFPA routine from the SPICE library.

Returns:

a boolean indicating if an array was found

Throws:

PatriusException - if there is a problem accessing/reading the current file

getSummaryOfArray

public static double[] getSummaryOfArray()
                                  throws PatriusException

Return (get) the summary for the current array in the current DAF.
Based on DAFGS from the SPICE library

Returns:

double precision array with the array summary content

Throws:

PatriusException - if there is a problem while reading the file

getNameOfArray

public static String getNameOfArray()
                             throws PatriusException

Return (get) the name for the current array in the current DAF.
Based on DAFGN of the SPICE library.

Returns:

the name for the current array in the current DAF

Throws:

IOException - if there is problem while reading a character record

PatriusException - if there is a problem in regarding the SPICE algorithm

readCharacterRecordDaf

public static String readCharacterRecordDaf(int handle,
                                            int record)
                                     throws PatriusException

Read the contents of a character record from a DAF.
Based on DAFRCR from the SPICE library.

Parameters:

handle - Handle of DAF

record - Record number of character record

Returns:

the Character record

Throws:

IOException - if there is a problem reading the file

PatriusException - if the access method is not correct