rsspice 0.1.0

//
// GENERATED FILE
//

use super::*;
use crate::SpiceContext;
use f2rust_std::*;

const NDC: i32 = 2;
const NIC: i32 = 6;
const QSIZ: i32 = 4;
const QAVSIZ: i32 = 7;
const DTYPE: i32 = 3;

/// C-kernel, get record, type 03
///
/// Return a specified pointing instance from a CK type 03 segment.
/// The segment is identified by a CK file handle and segment
/// descriptor.
///
/// # Required Reading
///
/// * [CK](crate::required_reading::ck)
/// * [DAF](crate::required_reading::daf)
///
/// # Brief I/O
///
/// ```text
///  VARIABLE  I/O  DESCRIPTION
///  --------  ---  --------------------------------------------------
///  HANDLE     I   The handle of the CK file containing the segment.
///  DESCR      I   The segment descriptor.
///  RECNO      I   The number of the pointing instance to be returned.
///  RECORD     O   The pointing record.
/// ```
///
/// # Detailed Input
///
/// ```text
///  HANDLE   is the handle of the binary CK file containing the
///           desired segment. The file should have been opened
///           for read or write access, by CKLPF, DAFOPR or DAFOPW.
///
///  DESCR    is the packed descriptor of the data type 3 CK segment.
///
///  RECNO    is the number of the discrete pointing instance to be
///           returned from the data type 3 segment.
/// ```
///
/// # Detailed Output
///
/// ```text
///  RECORD   is the pointing instance indexed by RECNO in the
///           segment. The contents are as follows:
///
///              RECORD( 1 ) = CLKOUT
///
///              RECORD( 2 ) = Q1
///              RECORD( 3 ) = Q2
///              RECORD( 4 ) = Q3
///              RECORD( 5 ) = Q4
///
///              RECORD( 6 ) = AV1  |
///              RECORD( 7 ) = AV2  |-- Returned optionally
///              RECORD( 8 ) = AV3  |
///
///           CLKOUT is the encoded spacecraft clock time associated
///           with the returned pointing values.
///
///           The quantities Q1 - Q4 are the components of the
///           quaternion that represents the C-matrix that transforms
///           vectors from the inertial reference frame of the
///           segment to the instrument frame at time CLKOUT.
///
///           The quantities AV1, AV2, and AV3 represent the
///           angular velocity vector, and are returned only if
///           the segment contains angular velocity data. The
///           components of the angular velocity vector are
///           specified relative to the inertial reference
///           frame of the segment.
/// ```
///
/// # Exceptions
///
/// ```text
///  1)  If the segment is not of data type 3, the error
///      SPICE(CKWRONGDATATYPE) is signaled.
///
///  2)  If RECNO is less than one or greater than the number of
///      records in the specified segment, the error
///      SPICE(CKNONEXISTREC) is signaled.
///
///  3)  If the specified handle does not belong to any DAF file that
///      is currently known to be open, an error is signaled by a
///      routine in the call tree of this routine.
///
///  4)  If DESCR is not a valid descriptor of a segment in the CK
///      file specified by HANDLE, the results of this routine are
///      unpredictable.
/// ```
///
/// # Files
///
/// ```text
///  The CK file specified by HANDLE should be open for read or
///  write access.
/// ```
///
/// # Particulars
///
/// ```text
///  For a detailed description of the structure of a type 3 segment,
///  see the CK required reading.
///
///  This is a utility routine that may be used to read the individual
///  pointing instances that make up a type 3 segment. It is normally
///  used in conjunction with CKNR03, which gives the number of
///  pointing instances stored in a segment.
/// ```
///
/// # Examples
///
/// ```text
///  The numerical results shown for this example may differ across
///  platforms. The results depend on the SPICE kernels used as
///  input, the compiler and supporting libraries, and the machine
///  specific arithmetic implementation.
///
///  1) The following code example extracts the SCLK time, boresight
///     vector, and angular velocity vector for each pointing instance
///     in the first segment in a CK file that contains segments of
///     data type 3.
///
///     Use the CK kernel below, available in the Venus Express PDS
///     archives, as input for the code example.
///
///        VEX_BOOM_V01.BC
///
///     Example code begins here.
///
///
///           PROGRAM CKGR03_EX1
///           IMPLICIT NONE
///
///     C
///     C     Local variables.
///     C
///           DOUBLE PRECISION      QUAT    ( 4 )
///           DOUBLE PRECISION      AV      ( 3 )
///           DOUBLE PRECISION      BORE    ( 3 )
///           DOUBLE PRECISION      CMAT    ( 3, 3 )
///           DOUBLE PRECISION      DCD     ( 2 )
///           DOUBLE PRECISION      DESCR   ( 5 )
///           DOUBLE PRECISION      RECORD  ( 8 )
///           DOUBLE PRECISION      SCLKDP
///
///           INTEGER               I
///           INTEGER               ICD     ( 6 )
///           INTEGER               HANDLE
///           INTEGER               NREC
///
///           LOGICAL               AVSEG
///           LOGICAL               FOUND
///
///     C
///     C     First load the file (it may also be opened by using
///     C     CKLPF).
///     C
///           CALL DAFOPR ( 'VEX_BOOM_V01.BC', HANDLE )
///
///     C
///     C     Begin forward search.  Find the first array.
///     C
///           CALL DAFBFS ( HANDLE )
///           CALL DAFFNA ( FOUND  )
///
///     C
///     C     Get segment descriptor.
///     C
///           CALL DAFGS ( DESCR )
///
///     C
///     C     Unpack the segment descriptor into its double precision
///     C     and integer components.
///     C
///           CALL DAFUS ( DESCR, 2, 6, DCD, ICD )
///
///     C
///     C     The data type for a segment is located in the third
///     C     integer component of the descriptor.
///     C
///           IF ( ICD( 3 ) .EQ. 3 ) THEN
///
///     C
///     C        Does the segment contain AV data?
///     C
///              AVSEG =  ( ICD(4) .EQ. 1 )
///
///     C
///     C        How many records does this segment contain?
///     C
///              CALL CKNR03 ( HANDLE, DESCR, NREC )
///
///              DO I = 1, NREC
///
///     C
///     C           Get the Ith pointing instance in the segment.
///     C
///                 CALL CKGR03 ( HANDLE, DESCR, I, RECORD )
///
///     C
///     C           Unpack RECORD into the time, quaternion, and av.
///     C
///                 SCLKDP = RECORD ( 1 )
///
///                 CALL MOVED ( RECORD(2), 4, QUAT )
///
///                 IF  ( AVSEG )  THEN
///                    CALL MOVED ( RECORD(6), 3, AV   )
///                 END IF
///
///     C
///     C           The boresight vector is the third row of the
///     C           C-matrix.
///     C
///                 CALL Q2M ( QUAT, CMAT )
///
///                 BORE(1) = CMAT(3,1)
///                 BORE(2) = CMAT(3,2)
///                 BORE(3) = CMAT(3,3)
///
///     C
///     C           Write out the results.
///     C
///                 WRITE (*,'(A,I2)') 'Record: ', I
///                 WRITE (*,'(A,F25.6)')  '   SCLK time       :',
///          .                               SCLKDP
///                 WRITE (*,'(A,3F14.9)') '   Boresight       :',
///          .                               BORE
///
///                 IF ( AVSEG ) THEN
///                    WRITE (*,'(A,3F14.9)') '   Angular velocity:',
///          .                                  AV
///                 END IF
///                 WRITE (*,*)
///
///              END DO
///
///           END IF
///
///           END
///
///
///     When this program was executed on a Mac/Intel/gfortran/64-bit
///     platform, the output was:
///
///
///     Record:  1
///        SCLK time       :           2162686.710986
///        Boresight       :  -0.999122830   0.000000000   0.041875654
///        Angular velocity:   0.000000000   0.000000000   0.000000000
///
///     Record:  2
///        SCLK time       :       54160369751.715164
///        Boresight       :  -0.999122830   0.000000000   0.041875654
///        Angular velocity:   0.000000000   1.176083393   0.000000000
///
///     Record:  3
///        SCLK time       :       54160454948.487686
///        Boresight       :   0.000000000   0.000000000   1.000000000
///        Angular velocity:   0.000000000   0.000000000   0.000000000
///
///     Record:  4
///        SCLK time       :      299264885854.937805
///        Boresight       :   0.000000000   0.000000000   1.000000000
///        Angular velocity:   0.000000000   0.000000000   0.000000000
///
///     Record:  5
///        SCLK time       :     2366007685832.532227
///        Boresight       :   0.000000000   0.000000000   1.000000000
///        Angular velocity:   0.000000000   0.000000000   0.000000000
///
///     Record:  6
///        SCLK time       :     4432750485810.126953
///        Boresight       :   0.000000000   0.000000000   1.000000000
///        Angular velocity:   0.000000000   0.000000000   0.000000000
///
///     Record:  7
///        SCLK time       :     6505155594828.757812
///        Boresight       :   0.000000000   0.000000000   1.000000000
///        Angular velocity:   0.000000000   0.000000000   0.000000000
///
///     Record:  8
///        SCLK time       :     8571898394806.352539
///        Boresight       :   0.000000000   0.000000000   1.000000000
///        Angular velocity:   0.000000000   0.000000000   0.000000000
///
///     Record:  9
///        SCLK time       :    10638641194783.947266
///        Boresight       :   0.000000000   0.000000000   1.000000000
///        Angular velocity:   0.000000000   0.000000000   0.000000000
///
///     Record: 10
///        SCLK time       :    12705383994761.541016
///        Boresight       :   0.000000000   0.000000000   1.000000000
///        Angular velocity:   0.000000000   0.000000000   0.000000000
///
///     Record: 11
///        SCLK time       :    14777789103780.169922
///        Boresight       :   0.000000000   0.000000000   1.000000000
///        Angular velocity:   0.000000000   0.000000000   0.000000000
///
///     Record: 12
///        SCLK time       :    16844531903757.763672
///        Boresight       :   0.000000000   0.000000000   1.000000000
///        Angular velocity:   0.000000000   0.000000000   0.000000000
///
///     Record: 13
///        SCLK time       :    18911274703735.359375
///        Boresight       :   0.000000000   0.000000000   1.000000000
///        Angular velocity:   0.000000000   0.000000000   0.000000000
/// ```
///
/// # Restrictions
///
/// ```text
///  1)  The binary CK file containing the segment whose descriptor was
///      passed to this routine must be opened for read or write access
///      by CKLPF, DAFOPR or DAFOPW.
/// ```
///
/// # Author and Institution
///
/// ```text
///  J. Diaz del Rio    (ODC Space)
///  J.M. Lynch         (JPL)
///  E.D. Wright        (JPL)
/// ```
///
/// # Version
///
/// ```text
/// -    SPICELIB Version 1.1.1, 26-OCT-2021 (JDR)
///
///         Edited the header to comply with NAIF standard. Added
///         reference to required CK in example's problem statement.
///
///         Fixed minor language issues in $Abstract, $Brief_I/O,
///         $Detailed_Input, $Files and $Restrictions sections.
///
/// -    SPICELIB Version 1.1.0, 07-SEP-2001 (EDW)
///
///         Replaced DAFRDA call with DAFGDA.
///         Added IMPLICIT NONE.
///
/// -    SPICELIB Version 1.0.0, 25-NOV-1992 (JML)
/// ```
pub fn ckgr03(
    ctx: &mut SpiceContext,
    handle: i32,
    descr: &[f64],
    recno: i32,
    record: &mut [f64],
) -> crate::Result<()> {
    CKGR03(handle, descr, recno, record, ctx.raw_context())?;
    ctx.handle_errors()?;
    Ok(())
}

//$Procedure CKGR03 ( C-kernel, get record, type 03 )
pub fn CKGR03(
    HANDLE: i32,
    DESCR: &[f64],
    RECNO: i32,
    RECORD: &mut [f64],
    ctx: &mut Context,
) -> f2rust_std::Result<()> {
    let DESCR = DummyArray::new(DESCR, 1..);
    let mut RECORD = DummyArrayMut::new(RECORD, 1..);
    let mut ICD = StackArray::<i32, 6>::new(1..=NIC);
    let mut NREC: i32 = 0;
    let mut BEG: i32 = 0;
    let mut END: i32 = 0;
    let mut ADDR: i32 = 0;
    let mut PSIZ: i32 = 0;
    let mut DCD = StackArray::<f64, 2>::new(1..=NDC);
    let mut NPOINT: f64 = 0.0;

    //
    // SPICELIB functions
    //

    //
    // Local parameters
    //
    //    NDC        is the number of double precision components in an
    //               unpacked C-kernel segment descriptor.
    //
    //    NIC        is the number of integer components in an unpacked
    //               C-kernel segment descriptor.
    //
    //    QSIZ       is the number of double precision numbers making up
    //               the quaternion portion of a pointing record.
    //
    //    QAVSIZ     is the number of double precision numbers making up
    //               the quaternion and angular velocity portion of a
    //               pointing record.
    //
    //    DTYPE      is the data type of the segment that this routine
    //               operates on.
    //
    //

    //
    // Local variables
    //

    //
    // Standard SPICE error handling.
    //
    if RETURN(ctx) {
        return Ok(());
    } else {
        CHKIN(b"CKGR03", ctx)?;
    }

    //
    // The unpacked descriptor contains the following information
    // about the segment:
    //
    //    DCD(1)  Initial encoded SCLK
    //    DCD(2)  Final encoded SCLK
    //    ICD(1)  Instrument
    //    ICD(2)  Inertial reference frame
    //    ICD(3)  Data type
    //    ICD(4)  Angular velocity flag
    //    ICD(5)  Initial address of segment data
    //    ICD(6)  Final address of segment data
    //
    // From the descriptor, determine
    //
    //   1 - Is this really a type 3 segment?
    //   2 - The beginning address of the segment.
    //   3 - The number of pointing instances in the segment (it's the
    //       last word in the segment).
    //   4 - The existence of angular velocity data, which determines how
    //       big the pointing portion of the returned record will be.
    //
    DAFUS(
        DESCR.as_slice(),
        NDC,
        NIC,
        DCD.as_slice_mut(),
        ICD.as_slice_mut(),
    );

    if (ICD[3] != DTYPE) {
        SETMSG(
            b"Data type of the segment should be 3: Passed descriptor shows type = #.",
            ctx,
        );
        ERRINT(b"#", ICD[3], ctx);
        SIGERR(b"SPICE(CKWRONGDATATYPE)", ctx)?;
        CHKOUT(b"CKGR03", ctx)?;
        return Ok(());
    }

    if (ICD[4] == 1) {
        PSIZ = QAVSIZ;
    } else {
        PSIZ = QSIZ;
    }

    BEG = ICD[5];
    END = ICD[6];

    DAFGDA(HANDLE, END, END, std::slice::from_mut(&mut NPOINT), ctx)?;

    NREC = intrinsics::IDNINT(NPOINT);

    //
    // If a request was made for a record which doesn't exist, then
    // signal an error and leave.
    //
    if ((RECNO < 1) || (RECNO > NREC)) {
        SETMSG(
            b"Requested record number (#) does not exist. There are # records in the segment.",
            ctx,
        );
        ERRINT(b"#", RECNO, ctx);
        ERRINT(b"#", NREC, ctx);
        SIGERR(b"SPICE(CKNONEXISTREC)", ctx)?;
        CHKOUT(b"CKGR03", ctx)?;
        return Ok(());
    }

    //
    // Get the pointing record indexed by RECNO.
    //
    ADDR = (BEG + (PSIZ * (RECNO - 1)));

    DAFGDA(
        HANDLE,
        ADDR,
        ((ADDR + PSIZ) - 1),
        RECORD.subarray_mut(2),
        ctx,
    )?;

    //
    // Next get the SCLK time.  Need to go past all of the NREC pointing
    // records (PSIZ * NREC numbers), and then to the RECNOth SCLK
    // time.
    //
    ADDR = (((BEG + (PSIZ * NREC)) + RECNO) - 1);

    DAFGDA(HANDLE, ADDR, ADDR, RECORD.subarray_mut(1), ctx)?;

    CHKOUT(b"CKGR03", ctx)?;
    Ok(())
}