Next: PAR_GET0x - Obtains a scalar value from a parameter
Up: Reference Manual
Previous: PAR_GDR1x - Obtains an exact number of values within a given range from a parameter
PAR_GDRVx
- Obtains a vector of values within a given range from a parameter
- Description:
This routine obtains up to a given number of values from a
parameter. All the values must be within a supplied range of
acceptable values.
- Invocation:
CALL PAR_GDRVx( PARAM, MAXVAL, VMIN, VMAX, VALUES, ACTVAL,
STATUS )
- Arguments:
-
PARAM = CHARACTER * ( * ) (Given)
-
The name of the parameter.
-
MAXVAL = INTEGER (Given)
-
The maximum number of values required. A PAR__ERROR status is
returned when the number of values requested is less than one.
-
VMIN = ? (Given)
-
The value immediately above a range wherein the obtained
values cannot lie. Thus if VMAX is greater than VMIN, VMIN
is the minimum allowed for the obtained values. However,
should VMAX be less than VMIN, all values are acceptable
except those between VMAX and VMIN exclusive.
-
VMAX = ? (Given)
-
The value immediately below a range wherein the obtained
values cannot lie. Thus if VMAX is greater than VMIN, VMAX
is the maximum allowed for the obtained values. However,
should VMAX be less than VMIN, all values are acceptable
except those between VMAX and VMIN exclusive.
-
VALUES( MAXVAL ) = ? (Returned)
-
The values associated with the parameter. They will only be
valid if STATUS is not set to an error value.
-
ACTVAL = INTEGER (Returned)
-
The actual number of values obtained.
-
STATUS = INTEGER (Given and Returned)
-
The global status.
- Notes:
-
There is a routine for each of the data types double precision,
integer, and real: replace "x" in the routine name by D, I, or R
respectively as appropriate. The VMIN, VMAX, and VALUES arguments
all must have the corresponding data type.
-
Should too many values be read, the parameter system will
repeat the get in order to obtain a permitted number of values.
-
If any of the values violates the constraint, the user is
informed of the constraint and prompted for another vector of
values. This is not achieved through the MIN/MAX system.
Next: PAR_GET0x - Obtains a scalar value from a parameter
Up: Reference Manual
Previous: PAR_GDR1x - Obtains an exact number of values within a given range from a parameter
PAR Interface to the ADAM Parameter System
Starlink User Note 114
Malcolm J. Currie
Alan J. Chipperfield
1999 September 24
E-mail:ussc@star.rl.ac.uk