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

Class SpiceFrame

java.lang.Object

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

public final class SpiceFrame
extends Object

This class contains the methods necessaries for manipulating different reference frames.

It is build as an adaptation of the framex.for file from the SPICE library.

Since:

4.11

Author:

T0281925

Field Summary

Fields

Modifier and Type	Field and Description
static int	CK CK frame type.
static int	INERTL Inertial frame type.
static int	NINERT Number of inertial frames.
static int	PCK PCK frame type.
static int	TK TK frame type.

Method Summary

Modifier and Type	Method and Description
static String	frameId2Name(int code) Retrieve the name of a reference frame associated with a SPICE ID code.
static boolean	frameInfo(int frCode, int[] cent, int[] frClass, int[] classId) Retrieve the minimal attributes associated with a frame needed for converting transformations to and from it.
static int	frameName2Id(String frame) Look up the frame ID code associated with a string.
static int	frameName2IdBypass(CounterArray usrctr, String[] savnam, int[] savcde, String nameF) Translate a string containing a frame name to its ID code, but bypass calling frameName2Id and return saved value provided by the caller if the name is the same as the saved name and the POOL state did not change.
static boolean	getFrameFromClass(int frClass, int classId, int[] frCode, String[] frName, int[] cent) Getter for the frame name, frame ID, and center associated with a given frame class and class ID.
static boolean	isInertial(int code) Determine if a frame ID code corresponds to an inertial frame code.

Methods inherited from class java.lang.Object

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

Field Detail

NINERT

public static final int NINERT

Number of inertial frames.

See Also:

Constant Field Values

INERTL

public static final int INERTL

Inertial frame type.

See Also:

Constant Field Values

PCK

public static final int PCK

PCK frame type.

See Also:

Constant Field Values

CK

public static final int CK

CK frame type.

See Also:

Constant Field Values

TK

public static final int TK

TK frame type.

See Also:

Constant Field Values

Method Detail

frameId2Name

public static String frameId2Name(int code)
                           throws PatriusException

Retrieve the name of a reference frame associated with a SPICE ID code.

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

Parameters:

code - an integer code for a reference frame

Returns:

the name associated with the reference frame

Throws:

PatriusException - if there is a problem with the counter array or with the pool

frameName2Id

public static int frameName2Id(String frame)
                        throws PatriusException

Look up the frame ID code associated with a string.

Parameters:

frame - The name of some reference frame

Returns:

the SPICE ID code of the frame

Throws:

PatriusException - if there is a problem with the counter array or with the pool

frameInfo

public static boolean frameInfo(int frCode,
                                int[] cent,
                                int[] frClass,
                                int[] classId)
                         throws PatriusException

Retrieve the minimal attributes associated with a frame needed for converting transformations to and from it.

This method is based on the FRINFO routine of the SPICE library.

Parameters:

frCode - the ID code for some frame

cent - (out) the center of the frame

frClass - (out) the class (type) of the frame

classId - (out) the ID code for the frame within its class

Returns:

true if the requested information is available

Throws:

PatriusException - if there is an initialization problem

getFrameFromClass

public static boolean getFrameFromClass(int frClass,
                                        int classId,
                                        int[] frCode,
                                        String[] frName,
                                        int[] cent)

Getter for the frame name, frame ID, and center associated with a given frame class and class ID.

Method based on the CCIFRM routine from the SPICE library.

Parameters:

frClass - Class of frame

classId - Class ID of frame

frCode - (out) ID code of the frame identified by FRCLSS, CLSSID

frName - (out) Name of the frame identified by FRCLSS, CLSSID

cent - (out) Center of the frame identified by FRCLSS, CLSSI

Returns:

true if the requested information is available

frameName2IdBypass

public static int frameName2IdBypass(CounterArray usrctr,
                                     String[] savnam,
                                     int[] savcde,
                                     String nameF)
                              throws PatriusException

Translate a string containing a frame name to its ID code, but bypass calling frameName2Id and return saved value provided by the caller if the name is the same as the saved name and the POOL state did not change.

Based on the ZZNAMFRM routine of the SPICE library.

Parameters:

usrctr - POOL state counter saved by the caller

savnam - Frame name saved by the caller

savcde - Frame ID code saved by the caller

nameF - Frame name

Returns:

the frame ID code

Throws:

PatriusException - if there is a problem checking a counter update or translating the name to Id

isInertial

public static boolean isInertial(int code)

Determine if a frame ID code corresponds to an inertial frame code.

Parameters:

code - frame SPICE ID code

Returns:

a boolean indicating if the frame is an inertial or non-inertial frame