- ←Prev
- KAPLIBS – Internal subroutines used within the KAPPA package.
- Next→
- TOC ↑
Description:
This
routine obtains one or more formatted values for a specified axis from the environment, using a
specified parameter.
If the string supplied for the parameter consists of a single colon, then a description of the Current
co-ordinate Frame is displayed, together with an indication of the format required for each axis value,
and a new parameter value is then obtained.
Invocation
CALL KPG1_GTAXV( PARAM, MXVAL,
EXACT, FRAME, IAXIS, AXVAL, NVAL, STATUS )
Arguments
PARAM = CHARACTER
(
)
(Given)
The name of the parameter to use.
MXVAL = INTEGER (Given)
The maximum number of
values which can be supplied. It is not an error for less than MXVAL to be supplied. Must be no more
than 20.
EXACT = LOGICAL( Given)
If .TRUE., then the user must supply exactly MXVAL values,
and he is reprompted if less than MXVAL are given. If .FALSE. then the user can give between 1 and
MXVAL values.
FRAME = INTEGER (Given)
A pointer to an AST Frame in which the axis lives.
IAXIS = INTEGER (Given)
The index of the axis within the Frame for which a value is required.
AXVAL( MXVAL ) = DOUBLE PRECISION (Given and Returned)
On entry, holds the axis
values to use as the dynamic default for the parameter. On exit, holds the supplied axis
value. No dynamic default is used if any of the supplied values is AST__BAD.
NVAL =
INTEGER (Returned)
The number of values obtained using the parameter and returned
in AXVAL.
STATUS = INTEGER (Given and Returned)
The global status.
Notes:
-
If a null (!) parameter value is supplied, the supplied value of AXVAL is returned, and the error is
annulled if the AXVAL value is not equal to AST__BAD.
-
AXVAL is left unchanged if an error has already occurred.
-
AST__BAD is returned in AXVAL if an error occurs during this routine.
- ←Prev
- KAPLIBS – Internal subroutines used within the KAPPA package.
- Next→
- TOC ↑