Procedure

     ERRPRT ( Get/Set Error Output Items )

     SUBROUTINE ERRPRT ( OP, LIST )

Abstract

     Retrieve or set the list of error message items
     to be output when an error is detected.

Required_Reading

     ERROR

Keywords

     ERROR

Declarations

     IMPLICIT NONE

      CHARACTER*(*)          OP
      CHARACTER*(*)          LIST

Brief_I/O

     VARIABLE  I/O  DESCRIPTION
     --------  ---  --------------------------------------------------
     OP         I   The operation:  'GET' or 'SET'.
     LIST      I-O  Specification of error messages to be output.

Detailed_Input

     OP       indicates the operation to be performed. Possible
              values are 'GET' and 'SET'.

              'SET' means, "the following list specifies the default
              selection of error messages to be output." These are
              the messages that will be output to the default error
              output device (selected by ERRDEV) when an error is
              detected.

              'GET' means, "return the current list of error output
              items." This is the exact list that was set by the
              last call to this routine with the 'SET' option.

              The option can be specified in mixed case. For example,
              the following call will work:

              CALL ERRPRT ( 'SeT' , 'ALL' )


     LIST     is a list of error message items. The items
              are delimited by commas. The items that can be
              in the list are the words:

              1.  SHORT        ...indicates the short error message
              2.  EXPLAIN      ...the explanation of the short message
              3.  LONG         ...the long error message
              4.  TRACEBACK    ...the traceback
              5.  ALL          ...indicates "output all messages"
              6.  NONE         ...indicates "don't output any messages"
              7.  DEFAULT      ...same as ALL, but includes default
                                  message

              A "list" is a character string containing some or
              all of the above words, delimited by commas. Examples
              are:

              1.  'SHORT, EXPLAIN'
              2.  'SHORT, LONG'
              3.  'ALL'
              4.  'NONE'
              5.  'ALL, NONE, ALL, SHORT, NONE'

              Each word in the list can be thought of as
              "flipping a switch" to enable or disable the output
              of the message(s) indicated by the word. The
              words are acted on in the order they occur in the
              list, starting with the leftmost word. As examples,
              consider the sample lists above.

              The effect of the first list above, 'SHORT, EXPLAIN',
              is to enable the output of the short error message
              and the explanatory text corresponding to it.

              The effect of the second list is to enable the output
              of the short and long messages.

              The effect of the third list is to enable the output of
              all of the error messages (short, long, explanation
              of the short message, and traceback).

              The effect of the fourth list is to disable output of
              all of the messages.

              The effect of the fifth list is to disable output of
              all of the messages. The reason for this is that
              the words in the list are responded to in order,
              from left to right, and "NONE" is the last word.

              If any words other than SHORT, LONG, EXPLAIN, ALL,
              DEFAULT, TRACEBACK or NONE appear in LIST, those words
              that are recognized are responded to. The words
              that are not recognized are diagnosed as
              erroneous, and error messages are generated
              for each such unrecognized word.

              The length of LIST is caller-defined, but only
              the first 100 characters of LIST will be saved
              for later retrieval.

              Only the first 10 items in the list are used;
              the rest are ignored.

Detailed_Output

     LIST     is a list of error message items. The value of
              LIST is that set by the last call to this routine
              using the 'SET' option. See "Detailed Input"
              for a description of the possible values and
              meanings of LIST.

              The initial value returned is 'DEFAULT'.

              Only the first 100 characters of LIST are saved
              when the list is set; any additional characters
              are truncated. Therefore, the first 100
              characters, at most, of the saved value of LIST
              will be returned.

Parameters

     None.

Exceptions

     1)  If an invalid value of the argument OP is supplied, the error
         SPICE(INVALIDOPERATION) is signaled.

     2)  If OP is 'SET' and an invalid word is detected within the list
         of error message items LIST, the error SPICE(INVALIDLISTITEM)
         is signaled.

Files

     None.

Particulars

     This routine is part of the SPICELIB error handling mechanism.

     Please read the "required reading"!

     This routine is intended to be used in conjunction with
     ERRDEV, which selects the default output device to which
     the error messages selected by this routine will be
     output.

     Additionally, the error response action must be
     something other than 'IGNORE' if the error messages
     are to be output. Possible choices of the error
     response action are 'RETURN', 'REPORT', 'ABORT', 'DEFAULT', and
     'IGNORE'.  Use ERRACT to set the error response action.


     Only the first 100 characters of LIST are saved.

     The default set of error messages that are output is the
     set specified by 'DEFAULT'; i.e., all of them, including
     the 'default' message.

Examples

     1. In this example, we select as the output device
        the file, SPUD.DAT, and then select the error
        messages to be output. We choose the short
        error message and the traceback. Since a
        different set of messages may have been selected
        previously, we clear the old setting by putting
        the word, 'NONE', at the beginning of the list.

        C
        C      Set the error output device to SPUD.DAT:
        C

               CALL ERRDEV (  'SET',  'SPUD.DAT'  )

        C
        C      Choose error messages:
        C

               CALL ERRPRT (  'SET',  'NONE, SHORT, TRACEBACK'  )

Restrictions

     1)  The device to which the selected error messages will be
         written must be selected via ERRDEV; otherwise, messages will
         be written to the initial default device.

     2)  Only the first 100 characters of LIST are saved.

Literature_References

     None.

Author_and_Institution

     N.J. Bachman       (JPL)
     J. Diaz del Rio    (ODC Space)
     W.L. Taber         (JPL)

Version

    SPICELIB Version 1.2.0, 19-APR-2021 (JDR)

        Added IMPLICIT NONE statement.

        Edited the header to comply with NAIF standard. $Exceptions
        section has been completely updated to provide only the list
        of exceptions. Additional information provided there has been
        moved to $Particulars.

    SPICELIB Version 1.1.0, 28-AUG-1999 (NJB)

        Output string is now built on the fly. The routine previously
        returned a saved string which could fail to represent correctly
        the set of selected message types.

    SPICELIB Version 1.0.1, 10-MAR-1992 (WLT)

        Comment section for permuted index source lines was added
        following the header.

    SPICELIB Version 1.0.0, 31-JAN-1990 (NJB)