Procedure

     GFREPI ( GF, progress report initialization )

     ENTRY GFREPI ( WINDOW, BEGMSS, ENDMSS )

Abstract

     Initialize a search progress report.

Required_Reading

     GF

Keywords

     SEARCH
     UTILITY

Declarations

    DOUBLE PRECISION      WINDOW ( LBCELL : * )
    CHARACTER*(*)         BEGMSS
    CHARACTER*(*)         ENDMSS

Brief_I/O

     VARIABLE  I/O  DESCRIPTION
     --------  ---  --------------------------------------------------
     LBCELL     P   The SPICE cell lower bound.
     MXBEGM     P   Maximum progress report message prefix length.
     MXENDM     P   Maximum progress report message suffix length.
     WINDOW     I   A window over which a job is to be performed.
     BEGMSS     I   Beginning of the text portion of output message.
     ENDMSS     I   End of the text portion of output message.

Detailed_Input

     WINDOW   is the name of a constraint window. This is the window
              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.

     BEGMSS   is the beginning of the progress report message written
              to standard output by the GF subsystem. This output
              message has the form

                 BEGMSS(1:LASTNB(BEGMSS)) // ' xxx.xx% ' // ENDMSS

              The total length of BEGMSS must be less than MXBEGM
              characters. All characters of BEGMSS must be printable.

              For example, the progress report message created by the
              SPICELIB routine GFOCCE at the completion of a search is

                 Occultation/transit search 100.00% done.

              In this message, BEGMSS is

                 'Occultation/transit search'

     ENDMSS   is the last portion of the output message written to
              standard output by the GF subsystem.

              The total length of ENDMSS must be less than MXENDM
              characters. All characters of ENDMSS must be printable.

              In the progress report message created by GFOCCE at the
              completion of a search, ENDMSS is

                 'done.'

Detailed_Output

     None.

Parameters

     LBCELL   is the SPICE cell lower bound.

     MXBEGM,
     MXENDM   are, respectively, the maximum lengths of the progress
              report message prefix and suffix. See the INCLUDE file
              zzgf.inc for details.

Exceptions

     1)  If BEGMSS has length greater than MXBEGM characters, or if
         ENDMSS has length greater than MXENDM characters, the error
         SPICE(MESSAGETOOLONG) is signaled.

     2)  If either BEGMSS or ENDMSS contains non-printing characters,
         the error SPICE(NOTPRINTABLECHARS) is signaled.

Files

     None.

Particulars

     This entry point initializes the GF progress reporting system. It
     is called by the GF root finding utilities once at the start of
     each search pass. See the $Particulars section of the main
     subroutine header for further details of its function.

Examples

     See $Examples in GFRPRT.

Restrictions

     None.

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.

        Extended description of BEGMSS and ENDMSS arguments.

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

        Corrected declaration of WINDOW in the $Declarations
        section. Added description of LBCELL to the $Declarations,
        $Brief_I/O, and $Parameters sections.

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