- java.lang.Object
-
- spice.basic.FrameInfo
-
public class FrameInfo extends java.lang.Object
Class FrameInfo packages specification parameters common to all SPICE reference frames.Version 1.1.0 02-FEB-2011 (NJB)(EDW)
Alpha JNISpice build for Ames Reasearch Center. This version of the FrameInfo class includes a constructor with an argument list of the frame class and frame class ID.
Version 1.0.0 22-DEC-2009 (NJB)
-
-
Field Summary
Fields Modifier and Type Field Description private int
frameCenterID
private int
frameClass
private int
frameClassID
private int
frameID
-
Constructor Summary
Constructors Constructor Description FrameInfo(int frameIDCode)
Create a FrameInfo instance from a SPICE frame ID code.FrameInfo(int frameClass, int frameClassID)
Create a FrameInfo object from a frame class and frame class ID.FrameInfo(FrameInfo info)
Copy constructor.This constructor creates a deep copy.FrameInfo(ReferenceFrame ref)
Create a FrameInfo instance from a ReferenceFrame.
-
Method Summary
Modifier and Type Method Description int
getFrameCenterID()
Return the frame center ID code for this instance.int
getFrameClass()
Return the frame class for this instance.int
getFrameClassID()
Return the frame class ID for this instance.int
getFrameID()
Return the frame ID code for this instance.java.lang.String
toString()
Convert this instance to a String.
-
-
-
Constructor Detail
-
FrameInfo
public FrameInfo(int frameClass, int frameClassID) throws FrameNotFoundException, SpiceException
Create a FrameInfo object from a frame class and frame class ID.- Parameters:
frameClass
- intframeClassID
- int- Throws:
FrameNotFoundException
- exceptionSpiceException
- exception
-
FrameInfo
public FrameInfo(FrameInfo info)
Copy constructor.This constructor creates a deep copy.- Parameters:
info
- FrameInfo
-
FrameInfo
public FrameInfo(int frameIDCode) throws FrameNotFoundException, SpiceException
Create a FrameInfo instance from a SPICE frame ID code.- Parameters:
frameIDCode
- int- Throws:
FrameNotFoundException
- exceptionSpiceException
- exception
-
FrameInfo
public FrameInfo(ReferenceFrame ref) throws FrameNotFoundException, SpiceException
Create a FrameInfo instance from a ReferenceFrame.- Parameters:
ref
- ReferenceFrame- Throws:
FrameNotFoundException
- exceptionSpiceException
- exception
-
-
Method Detail
-
getFrameID
public int getFrameID()
Return the frame ID code for this instance.- Returns:
- int
-
getFrameCenterID
public int getFrameCenterID()
Return the frame center ID code for this instance.- Returns:
- int
-
getFrameClass
public int getFrameClass()
Return the frame class for this instance.- Returns:
- int
-
getFrameClassID
public int getFrameClassID()
Return the frame class ID for this instance.- Returns:
- int
-
toString
public java.lang.String toString()
Convert this instance to a String.- Overrides:
toString
in classjava.lang.Object
- Returns:
- String
-
-