KPG1_GTNDF

Gets an NDF or NDF section with a specified number of significant dimensions

Description:

The supplied parameter name is associated with an NDF through the environment, and an identifier is obtained for the NDF using the specified access mode. Each axis of the NDF is checked to see if is significant (i.e. has a size greater than 1). The index of each significant axis is returned in SDIM, and the bounds of the axis are returned in SLBND and SUBND. If EXACT is .TRUE., an error is reported if the number of significant axes is not exactly NDIM. If EXACT is .FALSE. an error is only reported if the number of significant dimensions is higher than NDIM. If there are less than NDIM significant dimensions then the insignificant dimensions are used (starting from the lowest) to ensure that the required number of dimensions are returned.

Invocation

CALL KPG1_GTNDF( PARAM, NDIM, EXACT, MODE, INDF, SDIM, SLBND, SUBND, STATUS )

Arguments

PARAM = CHARACTER ∗ ( ∗ ) (Given)
The parameter name.
NDIM = INTEGER (Given)
The number of dimensions required.
EXACT = LOGICAL (Given)
This should be supplied .FALSE. if an NDF with less than NDIM significant dimensions can be used.
MODE = CHARACTER ∗ ( ∗ ) (Given)
The access mode required for the NDF.
INDF = INTEGER (Returned)
An identifier for the NDF.
SDIM( NDIM ) = INTEGER (Returned)
The indices of the significant dimensions.
SLBND( NDIM ) = INTEGER (Returned)
The lower bounds of the significant dimensions. These are stored in the same order as the indices in SDIM.
SUBND( NDIM ) = INTEGER (Returned)
The upper bounds of the significant dimensions. These are stored in the same order as the indices in SDIM.
STATUS = INTEGER (Given and Returned)
The global status.