Next: NDF_XLOC - Obtain access to a named NDF extension via an HDS locator
Up: FORTRAN ROUTINE DESCRIPTIONS
Previous: NDF_XIARY - Obtain access to an array stored in an NDF extension
NDF_XGT0x
- Read a scalar value from a component within a named NDF extension
- Description:
The routine reads a scalar value from a component within a named
NDF extension. The extension must already exist, although the
component within the extension need not exist (a default value,
established beforehand, will be returned if necessary).
- Invocation:
CALL NDF_XGT0x( INDF, XNAME, CMPT, VALUE, STATUS )
- Arguments:
-
INDF = INTEGER (Given)
-
NDF identifier.
-
XNAME = CHARACTER * ( * ) (Given)
-
Name of the NDF extension.
-
CMPT = CHARACTER * ( * ) (Given)
-
Name of the component within the extension whose value is to be
obtained.
-
VALUE = ? (Given and Returned)
-
The value obtained from the extension component. Its type is
determined by the name of the routine called (see the Notes
section).
-
STATUS = INTEGER (Given and Returned)
-
The global status.
- Notes:
-
There is a routine for reading values with each of the
standard Fortran data types: integer, real, double precision,
logical and character. Replace the (lower case) "x" in the
routine name by I, R, D, L or C as appropriate.
-
The value given for the CMPT argument may be an
HDS path name,
consisting of several fields separated by '.', so
that an object
can be accessed in a sub-component (or a sub-sub-component...) of
an NDF extension. Array subscripts may also be included. Thus a
string such as 'CALIB.FILTER(3).WAVELENGTH' could be used as a
valid CMPT value.
-
If the requested component in the extension does not exist,
then the VALUE argument will be returned unchanged. A suitable
default should therefore be established before this routine is
called.
-
If the length of the character VALUE argument passed to the
NDF_XGT0C routine is too short to accommodate the returned result
without losing significant (non-blank) trailing characters, then
this will be indicated by an appended ellipsis, i.e. '...'. No
error will result.
Next: NDF_XLOC - Obtain access to a named NDF extension via an HDS locator
Up: FORTRAN ROUTINE DESCRIPTIONS
Previous: NDF_XIARY - Obtain access to an array stored in an NDF extension
Starlink User Note 33
R.F. Warren-Smith
11th January 2000
E-mail:rfws@star.rl.ac.uk
Copyright © 2000 Council for the Central Laboratory of the Research Councils