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

Class SpiceBody

java.lang.Object

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

public final class SpiceBody
extends Object

This class allows the translation of SPICE body identifiers to the body names and vice-versa. It will look first in the built-in database, and then in the kernel manager if it has read bodies information.

This class is based on the bodc2n, bodc2s and zzbodtrn files of the SPICE library.

Since:

4.11

Author:

T0281925

Method Summary

Modifier and Type	Method and Description
static String	bodyCode2Name(int code) Translate the SPICE integer code of a body into a common name for that body. This routine is a translation of the BODC2N routine from the Spice library
static String	bodyCode2String(int code) Translate a body ID code to either the corresponding name or if no name to ID code mapping exists, the string representation of the body ID value.
static int	bodyName2Code(String name, boolean[] found) Translate the name of a body or object to the corresponding SPICE ID code.
static int	bodyString2Code(String name, boolean[] found) Translate a string representing a body name into its code.
static int	bodyString2CodeBypass(CounterArray usrctr, String[] savName, int[] savCode, boolean[] savFound, String name, boolean[] found) Translate a string containing a body name or ID code to an integer code, but bypass calling SpiceBody#bodyString2Code(String) and return saved values provided by the caller if the name is the same as the saved name and the SpiceBody state did not change.

Methods inherited from class java.lang.Object

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

Method Detail

bodyCode2Name

public static String bodyCode2Name(int code)
                            throws PatriusException

Translate the SPICE integer code of a body into a common name for that body.
This routine is a translation of the BODC2N routine from the Spice library

Parameters:

code - Integer ID code to be translated into a name

Returns:

a common name for the body identified by code (if the code is not found, an empty string is returned)

Throws:

PatriusException - if there is a problem in the Pool

bodyName2Code

public static int bodyName2Code(String name,
                                boolean[] found)
                         throws PatriusException

Translate the name of a body or object to the corresponding SPICE ID code.

Based on the BODN2C routine from the SPICE library

Parameters:

name - Body name to be translated into a SPICE ID code

found - (out) returns if the body was found

Returns:

SPICE integer ID code for the named body

Throws:

PatriusException - if there is a Pool or initialization problem

bodyCode2String

public static String bodyCode2String(int code)
                              throws PatriusException

Translate a body ID code to either the corresponding name or if no name to ID code mapping exists, the string representation of the body ID value.

This routine is a translation of the BODC2S routine from the SPICE library.

Parameters:

code - Integer ID code to be translated into a name

Returns:

a common name for the body identified by code (if the code is not found, an empty string is returned)

Throws:

PatriusException - if there is a problem translating the code to the name

bodyString2Code

public static int bodyString2Code(String name,
                                  boolean[] found)
                           throws PatriusException

Translate a string representing a body name into its code. If the name is a string representation of a integer, the integer represented is returned.

Parameters:

name - String representing a body name

found - (out) return if the body was found

Returns:

code corresponding to the string (0 if it was not found)

Throws:

PatriusException - if there is a problem translating the name into the code

bodyString2CodeBypass

public static int bodyString2CodeBypass(CounterArray usrctr,
                                        String[] savName,
                                        int[] savCode,
                                        boolean[] savFound,
                                        String name,
                                        boolean[] found)
                                 throws PatriusException

Translate a string containing a body name or ID code to an integer code, but bypass calling SpiceBody#bodyString2Code(String) and return saved values provided by the caller if the name is the same as the saved name and the SpiceBody state did not change.

Based on the routine ZZBODS2C routine of the SPICE library.

Parameters:

usrctr - (in/out) SpiceBody state counter saved by the caller

savName - (in/out) Body name saved by the caller

savCode - (in/out) Body ID code saved by the caller

savFound - (in/out) Translation success flag saved in the caller

name - Body name

found - (out) Translation success flag

Returns:

the body ID code

Throws:

PatriusException - if there is a problem checking the state or translating