JNISpice
version 2.0.0

spice.basic
Class FrameInfo

java.lang.Object
  extended by 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)


Constructor Summary
FrameInfo(FrameInfo info)
          Copy constructor.
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(ReferenceFrame ref)
          Create a FrameInfo instance from a ReferenceFrame.
 
Method Summary
 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FrameInfo

public FrameInfo(int frameClass,
                 int frameClassID)
          throws FrameNotFoundException,
                 SpiceException
Create a FrameInfo object from a frame class and frame class ID.

Throws:
FrameNotFoundException
SpiceException

FrameInfo

public FrameInfo(FrameInfo info)
Copy constructor. This constructor creates a deep copy.


FrameInfo

public FrameInfo(int frameIDCode)
          throws FrameNotFoundException,
                 SpiceException
Create a FrameInfo instance from a SPICE frame ID code.

Throws:
FrameNotFoundException
SpiceException

FrameInfo

public FrameInfo(ReferenceFrame ref)
          throws FrameNotFoundException,
                 SpiceException
Create a FrameInfo instance from a ReferenceFrame.

Throws:
FrameNotFoundException
SpiceException
Method Detail

getFrameID

public int getFrameID()
Return the frame ID code for this instance.


getFrameCenterID

public int getFrameCenterID()
Return the frame center ID code for this instance.


getFrameClass

public int getFrameClass()
Return the frame class for this instance.


getFrameClassID

public int getFrameClassID()
Return the frame class ID for this instance.


toString

public java.lang.String toString()
Convert this instance to a String.

Overrides:
toString in class java.lang.Object

JNISpice
version 2.0.0

JNISpice Alpha Test Version 2.0.0 28-JAN-2017 (NJB)