Learn About a Dimension

Learn dimension name and length in C. More...

Functions
int	PIOc_inq_dim (int ncid, int dimid, char *name, PIO_Offset *lenp)
	The PIO-C interface for the NetCDF function nc_inq_dim. More...
int	PIOc_inq_dimname (int ncid, int dimid, char *name)
	Find the name of a dimension. More...
int	PIOc_inq_dimlen (int ncid, int dimid, PIO_Offset *lenp)
	Find the length of a dimension. More...
int	PIOc_inq_dimid (int ncid, const char *name, int *idp)
	The PIO-C interface for the NetCDF function nc_inq_dimid. More...

Detailed Description

Learn dimension name and length in C.

Function Documentation

PIOc_inq_dim()

int PIOc_inq_dim	(	int	ncid,
		int	dimid,
		char *	name,
		PIO_Offset *	lenp
	)

The PIO-C interface for the NetCDF function nc_inq_dim.

This routine is called collectively by all tasks in the communicator ios.union_comm. For more information on the underlying NetCDF commmand please read about this function in the NetCDF documentation at: http://www.unidata.ucar.edu/software/netcdf/docs/group__dimensions.html

Parameters

ncid	the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile().
dimid	the dimension ID.
name	a pointer that gets the name of the dimension. Igorned if NULL. Name will be PIO_MAX_NAME chars or fewer.
lenp	a pointer that will get the number of values

Returns

PIO_NOERR for success, error code otherwise. See

PIOc_Set_File_Error_Handling()

Author

Jim Edwards, Ed Hartnett

PIOc_inq_dimid()

int PIOc_inq_dimid	(	int	ncid,
		const char *	name,
		int *	idp
	)

The PIO-C interface for the NetCDF function nc_inq_dimid.

This routine is called collectively by all tasks in the communicator ios.union_comm. For more information on the underlying NetCDF commmand please read about this function in the NetCDF documentation at: http://www.unidata.ucar.edu/software/netcdf/docs/group__dimensions.html

Parameters

ncid	the ncid of the open file, obtained from PIOc_openfile() or PIOc_createfile().
name	pointer taht gets the name of the dimension.
idp	a pointer that will get the id of the variable or attribute.

Returns

PIO_NOERR for success, error code otherwise. See PIOc_Set_File_Error_Handling

Author

Jim Edwards, Ed Hartnett

PIOc_inq_dimlen()

int PIOc_inq_dimlen	(	int	ncid,
		int	dimid,
		PIO_Offset *	lenp
	)

Find the length of a dimension.

Parameters

ncid	the ncid of an open file.
dimid	the dimension ID.
lenp	a pointer that gets the length of the dimension. Igorned if NULL.

Returns

0 for success, error code otherwise.

Author

Jim Edwards, Ed Hartnett

PIOc_inq_dimname()

int PIOc_inq_dimname	(	int	ncid,
		int	dimid,
		char *	name
	)

Find the name of a dimension.

Parameters

ncid	the ncid of an open file.
dimid	the dimension ID.
name	a pointer that gets the name of the dimension. Igorned if NULL. Name will be PIO_MAX_NAME chars or fewer.

Returns

0 for success, error code otherwise.

Author

Jim Edwards, Ed Hartnett