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

Class DafReader

java.lang.Object

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

public final class DafReader
extends Object

Class containing high level methods for the reading of several parts of a DAF binary file.

Based on several routines of the SPICE library.

Since:

4.11

Author:

T0281925

Method Summary

Modifier and Type	Method and Description
static void	readComments(int handle, int nLines, int lineSize, int[] nRead, String[] buffer, boolean[] done) Public method for the lecture of comments in a DAF file.
static double[]	readDataDaf(int handle, int begin, int end) Read the double precision data bounded by two addresses within a DAF.
static void	readFileRecord(int handle, int[] nd, int[] ni, String[] ifname, int[] fward, int[] bward, int[] free) Read the contents of the file record of a DAF.

Methods inherited from class java.lang.Object

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

Method Detail

readFileRecord

public static void readFileRecord(int handle,
                                  int[] nd,
                                  int[] ni,
                                  String[] ifname,
                                  int[] fward,
                                  int[] bward,
                                  int[] free)
                           throws PatriusException

Read the contents of the file record of a DAF.
The file record of a DAF is the only record that contains any global information about the file.

Based on the DAFRFR routine from the SPICE library.

Parameters:

handle - Handle of an open DAF file

nd - (output) Number of double precision components in summaries

ni - (output) Number of integer components in summaries

ifname - (output) Internal file name

fward - (output) Forward list pointer

bward - (output) Backward list pointer

free - (output) Free address pointer

Throws:

PatriusException - if the file is not open or there is a problem while reading the first record

readComments

public static void readComments(int handle,
                                int nLines,
                                int lineSize,
                                int[] nRead,
                                String[] buffer,
                                boolean[] done)
                         throws IOException,
                                PatriusException

Public method for the lecture of comments in a DAF file.

Parameters:

handle - Handle of binary DAF opened with read access

nLines - Maximum size, in lines, of BUFFER

lineSize - Number of characters in a line (normally 1000)

nRead - (output) Number of extracted comment lines

buffer - (output) Buffer where extracted comment lines are placed

done - (output) Indicates whether all comments have been extracted

Throws:

IOException - retrieves the errors from CommentSectionDAF.readComments

PatriusException - retrieves the errors from CommentSectionDAF.readComments

readDataDaf

public static double[] readDataDaf(int handle,
                                   int begin,
                                   int end)
                            throws PatriusException

Read the double precision data bounded by two addresses within a DAF.
Based on the DAFGDA routine from the SPICE library.

Parameters:

handle - Handle of a DAF

begin - Initial address within file

end - Final address within file

Returns:

data contained between begin and end

Throws:

PatriusException - retrieves the errors from ReadDoublePrecisionDAF.readContentDPRecord