Module JNISpice
Package spice.basic

Class 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)

    • Method Summary

      Modifier and Type Method Description
      SCLKTime getActualSCLKTime()
      Obtain the actual SCLK epoch from a PointingRecord.The epoch is available only if pointing was found when the record was created.
      Matrix33 getCMatrix()
      Obtain a C-matrix from a PointingRecord.The matrix is available only if pointing was found when the record was created.
      Instrument getInstrument()
      Get the Instrument from a pointing record.
      ReferenceFrame getReferenceFrame()
      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:
      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.The caller should always test the found flag before attempting to extract data from the pointing record.
      • 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​(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.
        Parameters:
        inst - Instrument
        tolerance - Duration
        t - Time
        ref - ReferenceFrame
        Throws:
        SpiceException - exception
    • 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.
        Returns:
        boolean
      • 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
           
        Returns:
        ReferenceFrame
        Throws:
        SpiceException - exception
      • getRequestSCLKTime

        public SCLKTime getRequestSCLKTime()
                                    throws SpiceException
        Get the request SCLK time from a pointing record.
        Returns:
        SCLKTime
        Throws:
        SpiceException - exception
      • 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.
        Returns:
        SLCKDuration