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

Class SpiceCommon

java.lang.Object

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

public final class SpiceCommon
extends Object

Class containing constants and auxiliary methods for the rest of the SPICE related classes.

Since:

4.11

Author:

T0281925

Field Summary

Fields

Modifier and Type	Field and Description
static String	BINARY_FORMAT Java binary format.
static int	BYTES_DOUBLE Number of bytes in a double precision number.
static int	CTRSIZ Size of counter arrays.
static String	DAF String literal for DAF architecture.
static String	EMPTY Empty string for comparisons.
static int	FILE_TABLE_SIZE Size of the file tables.
static int	MAX_CHAR_RECORD Max number of characters in a record.
static int	RECORD_LENGTH Number of bytes in a record.
static String	SPK String literal for SPK file type.
static String	UNKNOWN String to define an unknown architecture or file type.

Method Summary

Modifier and Type	Method and Description
static boolean	ftpCheck(String ftp) Check a character string that may contain the FTP validation string for FTP based errors.
static String[]	idword2architype(String idword) Extract the architecture and type of a SPICE binary kernel file from a file ID word.
static int	indexOfNoChar(String s, char ch) Find the first occurrence in a string of a character NOT being the char on input.
static void	unpackSummary(double[] sum, int nd, int ni, double[] dc, int[] ic) Unpack an array summary into its double precision and integer components.

Methods inherited from class java.lang.Object

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

Field Detail

CTRSIZ

public static final int CTRSIZ

Size of counter arrays.

See Also:

Constant Field Values

FILE_TABLE_SIZE

public static final int FILE_TABLE_SIZE

Size of the file tables.

See Also:

Constant Field Values

BINARY_FORMAT

public static final String BINARY_FORMAT

Java binary format.

See Also:

Constant Field Values

RECORD_LENGTH

public static final int RECORD_LENGTH

Number of bytes in a record.

See Also:

Constant Field Values

MAX_CHAR_RECORD

public static final int MAX_CHAR_RECORD

Max number of characters in a record.

See Also:

Constant Field Values

UNKNOWN

public static final String UNKNOWN

String to define an unknown architecture or file type.

See Also:

Constant Field Values

EMPTY

public static final String EMPTY

Empty string for comparisons.

See Also:

Constant Field Values

DAF

public static final String DAF

String literal for DAF architecture.

See Also:

Constant Field Values

SPK

public static final String SPK

String literal for SPK file type.

See Also:

Constant Field Values

BYTES_DOUBLE

public static final int BYTES_DOUBLE

Number of bytes in a double precision number.

See Also:

Constant Field Values

Method Detail

idword2architype

public static String[] idword2architype(String idword)
                                 throws PatriusException

Extract the architecture and type of a SPICE binary kernel file from a file ID word.

Based on IDW2AT routine from the SPICE library

Parameters:

idword - the ID word from a SPICE binary kernel file

Returns:

a 2 component array containing the architecture and the file type identified from the idword

Throws:

PatriusException - if the architecture is not DAF TODO change if more architectures are allowed

ftpCheck

public static boolean ftpCheck(String ftp)

Check a character string that may contain the FTP validation string for FTP based errors.

Based on the ZZFTPCHK routine from the SPICE library

Parameters:

ftp - String that may contain the FTP validation string

Returns:

boolean indicating if FTP corruption occurred

indexOfNoChar

public static int indexOfNoChar(String s,
                                char ch)

Find the first occurrence in a string of a character NOT being the char on input.

Based on the NCPOS routine in the SPICE library

Parameters:

s - Any character string

ch - a character

Returns:

the function returns the index of the first character of STR that is not the character in input. If no such character is found, the function returns -1

unpackSummary

public static void unpackSummary(double[] sum,
                                 int nd,
                                 int ni,
                                 double[] dc,
                                 int[] ic)

Unpack an array summary into its double precision and integer components.

Based on the DAFUS routine of the SPICE library

Parameters:

sum - Array summary

nd - Number of double precision components

ni - Number of integer components

dc - (out) Double precision components

ic - (out) Integer components