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

Class CommentSectionDAF

java.lang.Object

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

public final class CommentSectionDAF
extends Object

Class dedicated to the reading of the comment section of binary DAF files. A binary DAF contains an area which is reserved for storing annotations or descriptive textual information describing the data contained in a file. This area is referred to as the ''comment area'' of the file. The comment area of a DAF is a line oriented medium for storing textual information. The comment area preserves any leading or embedded white space in the line(s) of text which are stored, so that the appearance of the of information will be unchanged when it is retrieved (extracted) at some other time. The class is inspired by the dafec.for file from 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) This method will read the comments from the comment area of a binary DAF, placing them into a line buffer.

Methods inherited from class java.lang.Object

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

Method Detail

readComments

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

This method will read the comments from the comment area of a binary DAF, placing them into a line buffer. If the line buffer is not large enough to hold the entire comment area, the portion read will be returned to the caller, and the DONE flag will be set to .FALSE. This allows the comment area to be read in ``chunks,'' a buffer at a time. After all of the comment lines have been read, the DONE flag will be set to .TRUE. This method can be used to ``simultaneously'' extract comments from the comment areas of multiple binary DAFs. This method is based on the DAFEC routine from the SPICE library.

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 - in case there is a problem opening or reading the file

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