Learn About a File

Learn the number of variables, dimensions, global attributes, and the unlimited dimension ID in Fortran. More...

Functions/Subroutines
integer function	pio_nf::inq_ndims_id (ncid, ndims)
integer function	pio_nf::inq_nvars_id (ncid, nvars)
integer function	pio_nf::inq_natts_id (ncid, natts)
integer function	pio_nf::inq_unlimdim_desc (File, unlimdim)
	File descriptor structure. More...
integer function	pio_nf::inq_unlimdim_id (ncid, unlimdim)
integer function	pio_nf::inquire_desc (File, nDimensions, nVariables, nAttributes, unlimitedDimID)
	File descriptor structure. More...
integer function	pio_nf::inquire_id (ncid, nDimensions, nVariables, nAttributes, unlimitedDimID)

Detailed Description

Learn the number of variables, dimensions, global attributes, and the unlimited dimension ID in Fortran.

Use the generic functions to call the underlying Fortran functions.

Generic Function	Function(s)
pio_inquire()	inquire_desc(), inquire_id()

Function/Subroutine Documentation

inq_natts_id()

integer function pio_nf::inq_natts_id	(	integer, intent(in)	ncid,
		integer, intent(out)	natts
	)

Get information about the number of global attributes in a file or group.

Author

Jim Edwards

inq_ndims_id()

integer function pio_nf::inq_ndims_id	(	integer, intent(in)	ncid,
		integer, intent(out)	ndims
	)

Get information about the number of dimensions of a file or group.

Author

Jim Edwards

inq_nvars_id()

integer function pio_nf::inq_nvars_id	(	integer, intent(in)	ncid,
		integer, intent(out)	nvars
	)

Get information about the number of variables in a file or group.

Author

Jim Edwards

inq_unlimdim_desc()

integer function pio_nf::inq_unlimdim_desc	(	type (file_desc_t), intent(inout)	File,
		integer, intent(out)	unlimdim
	)

File descriptor structure.

Get information about the unlimited dimension in a file.

Parameters

File	This structure holds information associated with each open file
unlimdim	Pointer to the unlimted dimension. If no unlimited dimension, this will be -1.

Return values

ierr	The error return code (see Error Handling for Fortran).

Author

Jim Edwards

inq_unlimdim_id()

integer function pio_nf::inq_unlimdim_id	(	integer, intent(in)	ncid,
		integer, intent(out)	unlimdim
	)

Get information about the unlimited dimension in a file.

Author

Jim Edwards

inquire_desc()

integer function pio_nf::inquire_desc	(	type (file_desc_t), intent(in)	File,
		integer, intent(out), optional	nDimensions,
		integer, intent(out), optional	nVariables,
		integer, intent(out), optional	nAttributes,
		integer, intent(out), optional	unlimitedDimID
	)

File descriptor structure.

Gets metadata information for netcdf file.

Parameters

File	This structure holds information associated with each open file
nDimensions	Number of dimensions defined for the netcdf file
nVariables	Number of variables defined for the netcdf file
nAttributes	Number of attributes defined for the netcdf file
unlimitedDimID	the Unlimited dimension ID

Return values

ierr	The error return code (see Error Handling for Fortran).

Author

Jim Edwards

inquire_id()

integer function pio_nf::inquire_id	(	integer, intent(in)	ncid,
		integer, intent(out), optional	nDimensions,
		integer, intent(out), optional	nVariables,
		integer, intent(out), optional	nAttributes,
		integer, intent(out), optional	unlimitedDimID
	)

Gets metadata information for netcdf file.

Author

Jim Edwards