JNISpice
version 2.0.0

spice.basic
Class PointingRecord

java.lang.Object
  extended by spice.basic.PointingRecord
Direct Known Subclasses:
PointingAndAVRecord

public class PointingRecord
extends java.lang.Object

Class PointingRecord encapsulates outputs from C-kernel lookups.

Version 1.0.0 15-DEC-2009 (NJB)


Constructor Summary
PointingRecord()
          No-arguments constructor.
PointingRecord(Instrument inst, Time t, ReferenceFrame ref, Duration tolerance)
          Return a PointingRecord for a specified instrument or structure at a given time, using a specified lookup tolerance.
PointingRecord(PointingRecord rec)
          Copy constructor.
 
Method Summary
 SCLKTime getActualSCLKTime()
          Obtain the actual SCLK epoch from a PointingRecord.
 Matrix33 getCMatrix()
          Obtain a C-matrix from a PointingRecord.
 Instrument getInstrument()
          Get the Instrument from a pointing record.
 ReferenceFrame getReferenceFrame()
          Get the ReferenceFrame from a pointing record.
 SCLKTime getRequestSCLKTime()
          Get the request SCLK time from a pointing record.
 SCLKDuration getTolerance()
          Get the tolerance from a pointing record; the value is expressed in ticks of the clock associated with the record's Instrument.
 boolean wasFound()
          Retrieve the found flag from a PointingRecord.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PointingRecord

public PointingRecord()
No-arguments constructor.


PointingRecord

public PointingRecord(PointingRecord rec)
               throws SpiceException
Copy constructor. This constructor creates a deep copy.

Throws:
SpiceException

PointingRecord

public PointingRecord(Instrument inst,
                      Time t,
                      ReferenceFrame ref,
                      Duration tolerance)
               throws SpiceException
Return a PointingRecord for a specified instrument or structure at a given time, using a specified lookup tolerance.

Throws:
SpiceException
Method Detail

wasFound

public boolean wasFound()
Retrieve the found flag from a PointingRecord. The caller should always test the found flag before attempting to extract data from the pointing record.


getCMatrix

public Matrix33 getCMatrix()
                    throws PointingNotFoundException,
                           SpiceException
Obtain a C-matrix from a PointingRecord. The matrix is available only if pointing was found when the record was created.

Throws:
PointingNotFoundException
SpiceException

getActualSCLKTime

public SCLKTime getActualSCLKTime()
                           throws PointingNotFoundException,
                                  SpiceException
Obtain the actual SCLK epoch from a PointingRecord. The epoch is available only if pointing was found when the record was created.

Throws:
PointingNotFoundException
SpiceException

getReferenceFrame

public ReferenceFrame getReferenceFrame()
                                 throws SpiceException
Get the ReferenceFrame from a pointing record. This is the base frame for the C-matrix; the C-matrix maps vectors from the base frame to the instrument frame via left multiplication:
      V           = C-matrix * V
       instrument               base
   

Throws:
SpiceException

getInstrument

public Instrument getInstrument()
                         throws SpiceException
Get the Instrument from a pointing record.

Throws:
SpiceException

getRequestSCLKTime

public SCLKTime getRequestSCLKTime()
                            throws SpiceException
Get the request SCLK time from a pointing record.

Throws:
SpiceException

getTolerance

public SCLKDuration getTolerance()
Get the tolerance from a pointing record; the value is expressed in ticks of the clock associated with the record's Instrument.


JNISpice
version 2.0.0

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