next up previous contents
Next: Prompt for Double Up: Prompted Input Subprograms Previous: Prompt for Double

Prompt for Double Precision Member of Set

This Subprogram will prompt for the Operator to supply a response corresponding to a member of a Set of Double Precision Values. The specified Prompt will only be issued if the Operator has not anticipated the input request.

Short Name Calling Sequence

         STATUS = UIGTPM(PROMPT,SETVAL,SETSIZ,VALUE[,INDEX])
Long Name Calling Sequence

         STATUS = UI_GET_DOUBLE_MEMBER(...)

Input Arguments

         PROMPT (Character)     Prompt Text
         SETVAL (Real*8 Array)  Array of Set Members
         SETSIZ (Integer)       No. of Set Members
         VALUE  (Real*8)        Default Value

Output Arguments

         VALUE  (Real*8)        Response Value
         INDEX  (Integer)       Member Index within Set

Function Value

UI__SUCCESS ) Success UISUCC )

UI__DEFAULTED ) Input Defaulted UIDFLT )

UI__EMPTY_SET ) Empty Set UIEMST )

UI__NOT_INITIALIZED ) Package not Initialized UININI )

UI__INPUT_ABORTED ) Input Aborted (Ctrl-Z) UIABRT )

UI__NO_INPUT ) No Input present UINOIN )

UI__END_OF_FILE ) End-of-File detected UIEOF ) in Batch Mode Note:

  1. The FORTRAN-77 name does not follow the normal UIPACK naming conventions in order to avoid a conflict with UIGTDM (UI_GET_DECIMAL_MEMBER).
  2. The SETVAL Array should be dimensioned (SETSIZ) and should contain the valid Set Members. The response from the User will be forced to be equal to one of these values.
  3. The INDEX Argument is optional and, if present, will be set to the index (in the range 1-SETSIZ) of the Set Member that matched the response VALUE. If multiple Set Members have the same value, then INDEX will refer to the first one encountered.
  4. In order to cope with possible rounding errors, a match is assumed to take place if the response value is within 99% to 101% of a Set Member.
  5. The UI__DEFAULTED Function Value indicates that the User just accepted the default value (by typing RETURN only).
  6. The UI__EMPTY_SET Function Value indicates that the specified Set is empty (SETSIZ is zero or negative).
  7. The UI__INPUT_ABORTED Function Value indicates that the User typed Ctrl-Z to abort input. This is only implemented on a VAX/VMS system. It is an informational function value only, no error message will be reported.
  8. UI__NO_INPUT will only be returned in Asynchronous Mode (if both UI_INPUT_MODE and UI_GET_MODE have signified Asynchronous Input Mode) and indicates that the User has not yet specified any Input. The Application Program should poll by either calling this Subprogram repeatedly or by calling UI_TEST_INPUT repeatedly until this indicates that some Input has been received. In the latter case (UI_TEST_INPUT called) this Subprogram should be recalled in order to decode the input. UIPACK is setup by default such that this subprogram always acts synchronously unless a prior call to UI_GET_MODE has been made within the Application Program.
  9. The UI__END_OF_FILE Function Value indicates that an End-of-File was detected on the main Input Stream in Batch or non-interactive mode where Input is not taken from a terminal but rather from a file. It is a severe error and therefore causes an error to be reported (unless this has been inhibited by a prior call to UI_ERROR_LEVEL).
  10. The Prompt string will only be issued if the response is not already present in the input line. Thus this subprogram may be used by itself to accept input values, as part of the general decoding of a Command Line to prompt for Parameters associated with the present Verb, or to prompt for and pickup the value associated with a Qualifier.
  11. The format of the Prompt is:-

    Prompt String[Real]:
    

    or

    Prompt String [Real (lll:uuu)]:
    

    where ``lll" and ``uuu" are the lower and upper limits if specified.

  12. The format of allowed responses is:-

    ?
    snn
    snn:snn
    (nn,nn,snn)
    'nn,nn,snn'
    "nn,nn,snn"
    
    where:-
    
    ?       Request for Help
    s       is an optional sign [+/-]
    nn      is a string of decimal digits
    
    
    Examples:
    
             Response       Internal
    
             1              (1)
             (1,20)         (1,20)
             (1,10,20)      (1,10,20)
    


next up previous contents
Next: Prompt for Double Up: Prompted Input Subprograms Previous: Prompt for Double



Liz Buckle
Fri Jan 13 17:33:22 CST 1995