Procedure

     GFREPU ( GF, progress report update )

     ENTRY GFREPU ( IVBEG, IVEND, TIME )

Abstract

     Tell the progress reporting system how far a search has
     progressed.

Required_Reading

     GF

Keywords

     SEARCH
     UTILITY

Declarations

    DOUBLE PRECISION      IVBEG
    DOUBLE PRECISION      IVEND
    DOUBLE PRECISION      TIME

Brief_I/O

     VARIABLE  I/O  DESCRIPTION
     --------  ---  --------------------------------------------------
     IVBEG      I   Start time of work interval.
     IVEND      I   End time of work interval.
     TIME       I   Current time being examined in the search process

Detailed_Input

     IVBEG,
     IVEND    are the bounds of an interval that is contained in some
              interval belonging to the confinement window. The
              confinement window is associated with some root finding
              activity. It is used to determine how much total time is
              being searched in order to find the events of interest.

              In order for a meaningful progress report to be
              displayed, IVBEG and IVEND must satisfy the following
              constraints:

                 - IVBEG must be less than or equal to IVEND.

                 - The interval [ IVBEG, IVEND ] must be contained in
                   some interval of the confinement window. It can be
                   a proper subset of the containing interval; that
                   is, it can be smaller than the interval of the
                   confinement window that contains it.

                 - Over a search pass, the sum of the differences

                      IVEND - IVBEG

                   for all calls to this routine made during the pass
                   must equal the measure of the confinement window.


     TIME     is the current time reached in the search for an event.
              TIME must lie in the interval

                 IVBEG : IVEND

              inclusive. The input values of TIME for a given interval
              need not form an increasing sequence.

Detailed_Output

     None. This routine does perform console I/O when progress
     reporting is enabled.

Parameters

     None.

Exceptions

     1)  If IVBEG and IVEND are in decreasing order, the error
         SPICE(BADENDPOINTS) is signaled.

     2)  If TIME is not in the closed interval [IVBEG, IVEND], the
         error SPICE(VALUEOUTOFRANGE) is signaled.

     3)  If an I/O error results from writing to standard output, the
         error is signaled by a routine in the call tree of this
         routine.

Files

     None.

Particulars

     This entry point is used to indicate the current progress of a
     search. Using information recorded through the initialization
     entry point of this routine, the progress reporting system
     determines how much work has been completed and whether or not to
     report it on the users screen.

Examples

     See $Examples in GFRPRT.

Restrictions

     1)  This routine has no way of enforcing that the input values of
         IVBEG and IVEND are compatible with the input window passed to
         GFREPI. Callers of this routine are responsible for ensuring
         that this requirement is obeyed.

Literature_References

     None.

Author_and_Institution

     N.J. Bachman       (JPL)
     J. Diaz del Rio    (ODC Space)
     L.S. Elson         (JPL)
     B.V. Semenov       (JPL)
     W.L. Taber         (JPL)
     I.M. Underwood     (JPL)

Version

    SPICELIB Version 1.0.2, 27-AUG-2021 (JDR)

        Edited the header to comply with NAIF standard.

    SPICELIB Version 1.0.1, 10-FEB-2014 (BVS)

        Added declarations of IVBEG and IVEND to the $Declarations
        section.

    SPICELIB Version 1.0.0, 21-FEB-2009 (NJB) (LSE) (WLT) (IMU)