Next: Prompt for Filename
Up: Prompted Input Subprograms
Previous: Prompt for Double
This Subprogram will prompt for the Operator to supply 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 = UIGTPS(PROMPT,VALUES,VASIZE,
& NVALUE[,LOLIM,HILIM])
Long Name Calling Sequence
STATUS = UI_GET_DOUBLE_SET(...)
Input Arguments
PROMPT (Character) Prompt Text
VASIZE (Integer) Maximum No. of Values
LOLIM (Real*8) Low Limit (Optional)
HILIM (Real*8) High Limit (Optional)
Output Arguments
VALUES (Real*8 Array) Response Values Array
NVALUE (Integer) No. of returned Values
Function Value
UI__SUCCESS ) Success
UISUCC )
UI__NOT_INITIALIZED ) Package not Initialized
UININI )
UI__ILLEGAL_LIMITS ) Illegal Limit
UIILLI ) specification
UI__TRUNCATED ) List truncated
UITRUN )
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:
- The FORTRAN-77 name does not follow the normal UIPACK naming conventions
in order to avoid a conflict with UIGTDS (UI_GET_DECIMAL_SET).
- This Subprogram differs from UI_GET_DOUBLE_LIST in not allowing for
bounds specifications within the List. UI_GET_DOUBLE_LIST allows implied
sequences denoted by lower and upper bounds whereas this Subprogram only
allows for a sequence of enumerated Double Precision numbers.
- The VALUES Array should be dimensioned (VASIZE). On return it will be
setup to contain NVALUE entries, each specifying an enumerated real value.
No sorting is performed and thus the response:-
(1.0,5,2.0,3.0)
will cause the following settings:-
NVALUE = 4
VALUES(1) = 1.0
VALUES(2) = 5.0
VALUES(3) = 2.0
VALUES(4) = 3.0
- The range of allowed responses may be limited by specifying the optional
LOLIM and HILIM Arguments. If these are present they represent an inclusive
range, if absent, the VALUE may lie in the complete range of Double
Precision numbers.
- It is the Programmers responsibility to ensure that LOLIM (if specified)
is not greater than HILIM. Should this unphysical condition be the case, then
Function Value UI__ILLEGAL_LIMITS will be returned and the Default
VALUE will be unchanged.
- Unlike the other Prompted Input Subprograms UI_GET_REAL_SET does not
accept any Defaults. If a null response (all spaces) is returned then
NVALUE will be set to zero, indicating that no Elements are present.
- The UI__TRUNCATED Return indicates that the
list Array VALUES has been exceeded. Excess list elements have therefore been
lost.
- 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.
- 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.
- 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).
- 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.
- 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.
- The format of allowed responses is:-
?
snn.nnEsnn
(snn,snn.nn,snn.nnEsnn)
"snn,snn.nn,snn.nnEsnn"
'snn,snn.nn,snn.nnEsnn'
where:-
? Request for Help
s is an optional sign [+/-]
nn is a string of decimal digits
E signifies an exponent (optional)
D signifies an exponent (optional)
Examples:
Response Internal
1 (1.0)
(1,10.0,20.0E1) (1.0,10.0,200.0)
Next: Prompt for Filename
Up: Prompted Input Subprograms
Previous: Prompt for Double
Liz Buckle
Fri Jan 13 17:33:22 CST 1995