next up previous
Next: PAR_GETVx - Obtains a vector of values from a parameter regardless of the its shape
Up: Reference Manual
Previous: PAR_GET1x - Obtains a vector of values from a parameter

PAR_GETNx - Obtains an array parameter value    

Description:
This routine obtains an n-dimensional array of values from a parameter. If necessary, the values are converted to the required type.

Invocation:
CALL PAR_GETNx( PARAM, NDIM, MAXD, VALUES, ACTD, STATUS )

Arguments:
PARAM = CHARACTER * ( * ) (Given)
The parameter name.
NDIM = INTEGER (Given)
The number of dimensions of the values array. This must match the number of dimensions of the parameter.
MAXD( NDIM ) = INTEGER (Given)
Array specifying the maximum dimensions of the array to be read. These may not be smaller than the dimensions of the actual parameter nor greater than the dimensions of the VALUES array.
VALUES( * ) = ? (Returned)
The values obtained from the parameter. These are in Fortran order.
ACTD( NDIM ) = INTEGER (Returned)
The actual dimensions of the array. Unused dimensions are set to 1.
STATUS = INTEGER
The global status.

Notes:
  • There is a routine for each of the data types character, double precision, integer, logical, and real: replace "x" in the routine name by C, D, I, L, or R respectively as appropriate. The VALUES argument must have the corresponding data type.
  • Note that this routine will accept a scalar value, returning a single-element array with the specified number of dimensions.



next up previous
Next: PAR_GETVx - Obtains a vector of values from a parameter regardless of the its shape
Up: Reference Manual
Previous: PAR_GET1x - Obtains a vector of values 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