Read Arrays

Functions
int	PIOc_get_vara_text (int ncid, int varid, const PIO_Offset *start, const PIO_Offset *count, char *buf)
	Get a muti-dimensional subset of a text variable. More...
int	PIOc_get_vara_uchar (int ncid, int varid, const PIO_Offset *start, const PIO_Offset *count, unsigned char *buf)
	Get a muti-dimensional subset of an unsigned char variable. More...
int	PIOc_get_vara_schar (int ncid, int varid, const PIO_Offset *start, const PIO_Offset *count, signed char *buf)
	Get a muti-dimensional subset of a signed char variable. More...
int	PIOc_get_vara_ushort (int ncid, int varid, const PIO_Offset *start, const PIO_Offset *count, unsigned short *buf)
	Get a muti-dimensional subset of an unsigned 16-bit integer variable. More...
int	PIOc_get_vara_short (int ncid, int varid, const PIO_Offset *start, const PIO_Offset *count, short *buf)
	Get a muti-dimensional subset of a 16-bit integer variable. More...
int	PIOc_get_vara_long (int ncid, int varid, const PIO_Offset *start, const PIO_Offset *count, long *buf)
	Get a muti-dimensional subset of a 64-bit integer variable. More...
int	PIOc_get_vara_uint (int ncid, int varid, const PIO_Offset *start, const PIO_Offset *count, unsigned int *buf)
	Get a muti-dimensional subset of an unsigned integer variable. More...
int	PIOc_get_vara_int (int ncid, int varid, const PIO_Offset *start, const PIO_Offset *count, int *buf)
	Get a muti-dimensional subset of an integer variable. More...
int	PIOc_get_vara_float (int ncid, int varid, const PIO_Offset *start, const PIO_Offset *count, float *buf)
	Get a muti-dimensional subset of a floating point variable. More...
int	PIOc_get_vara_double (int ncid, int varid, const PIO_Offset *start, const PIO_Offset *count, double *buf)
	Get a muti-dimensional subset of a 64-bit floating point variable. More...
int	PIOc_get_vara_ulonglong (int ncid, int varid, const PIO_Offset *start, const PIO_Offset *count, unsigned long long *buf)
	Get a muti-dimensional subset of an unsigned 64-bit integer variable. More...
int	PIOc_get_vara_longlong (int ncid, int varid, const PIO_Offset *start, const PIO_Offset *count, long long *buf)
	Get a muti-dimensional subset of a 64-bit integer variable. More...
int	PIOc_get_vara (int ncid, int varid, const PIO_Offset *start, const PIO_Offset *count, void *buf)
	Get a muti-dimensional subset of a variable the same type as the variable in the file. More...

Detailed Description

Read arrays of data from a variable in C, specifying start and count arrays.

Function Documentation

PIOc_get_vara()

int PIOc_get_vara	(	int	ncid,
		int	varid,
		const PIO_Offset *	start,
		const PIO_Offset *	count,
		void *	buf
	)

Get a muti-dimensional subset of a variable the same type as the variable in the file.

This routine is called collectively by all tasks in the communicator ios.union_comm.

Parameters

ncid	identifies the netCDF file
varid	the variable ID number
start	an array of start indicies (must have same number of entries as variable has dimensions). If NULL, indices of 0 will be used.
count	an array of counts (must have same number of entries as variable has dimensions). If NULL, counts matching the size of the variable will be used.
buf	pointer that will get the data.

Returns

PIO_NOERR on success, error code otherwise.

Author

Ed Hartnett

PIOc_get_vara_double()

int PIOc_get_vara_double	(	int	ncid,
		int	varid,
		const PIO_Offset *	start,
		const PIO_Offset *	count,
		double *	buf
	)

Get a muti-dimensional subset of a 64-bit floating point variable.

This routine is called collectively by all tasks in the communicator ios.union_comm.

Parameters

ncid	identifies the netCDF file
varid	the variable ID number
start	an array of start indicies (must have same number of entries as variable has dimensions). If NULL, indices of 0 will be used.
count	an array of counts (must have same number of entries as variable has dimensions). If NULL, counts matching the size of the variable will be used.
buf	pointer that will get the data.

Returns

PIO_NOERR on success, error code otherwise.

Author

Ed Hartnett

PIOc_get_vara_float()

int PIOc_get_vara_float	(	int	ncid,
		int	varid,
		const PIO_Offset *	start,
		const PIO_Offset *	count,
		float *	buf
	)

Get a muti-dimensional subset of a floating point variable.

This routine is called collectively by all tasks in the communicator ios.union_comm.

Parameters

ncid	identifies the netCDF file
varid	the variable ID number
start	an array of start indicies (must have same number of entries as variable has dimensions). If NULL, indices of 0 will be used.
count	an array of counts (must have same number of entries as variable has dimensions). If NULL, counts matching the size of the variable will be used.
buf	pointer that will get the data.

Returns

PIO_NOERR on success, error code otherwise.

Author

Ed Hartnett

PIOc_get_vara_int()

int PIOc_get_vara_int	(	int	ncid,
		int	varid,
		const PIO_Offset *	start,
		const PIO_Offset *	count,
		int *	buf
	)

Get a muti-dimensional subset of an integer variable.

This routine is called collectively by all tasks in the communicator ios.union_comm.

Parameters

ncid	identifies the netCDF file
varid	the variable ID number
start	an array of start indicies (must have same number of entries as variable has dimensions). If NULL, indices of 0 will be used.
count	an array of counts (must have same number of entries as variable has dimensions). If NULL, counts matching the size of the variable will be used.
buf	pointer that will get the data.

Returns

PIO_NOERR on success, error code otherwise.

Author

Ed Hartnett

PIOc_get_vara_long()

int PIOc_get_vara_long	(	int	ncid,
		int	varid,
		const PIO_Offset *	start,
		const PIO_Offset *	count,
		long *	buf
	)

Get a muti-dimensional subset of a 64-bit integer variable.

This routine is called collectively by all tasks in the communicator ios.union_comm.

Parameters

ncid	identifies the netCDF file
varid	the variable ID number
start	an array of start indicies (must have same number of entries as variable has dimensions). If NULL, indices of 0 will be used.
count	an array of counts (must have same number of entries as variable has dimensions). If NULL, counts matching the size of the variable will be used.
buf	pointer that will get the data.

Returns

PIO_NOERR on success, error code otherwise.

Author

Ed Hartnett

PIOc_get_vara_longlong()

int PIOc_get_vara_longlong	(	int	ncid,
		int	varid,
		const PIO_Offset *	start,
		const PIO_Offset *	count,
		long long *	buf
	)

Get a muti-dimensional subset of a 64-bit integer variable.

This routine is called collectively by all tasks in the communicator ios.union_comm.

Parameters

ncid	identifies the netCDF file
varid	the variable ID number
start	an array of start indicies (must have same number of entries as variable has dimensions). If NULL, indices of 0 will be used.
count	an array of counts (must have same number of entries as variable has dimensions). If NULL, counts matching the size of the variable will be used.
buf	pointer that will get the data.

Returns

PIO_NOERR on success, error code otherwise.

Author

Ed Hartnett

PIOc_get_vara_schar()

int PIOc_get_vara_schar	(	int	ncid,
		int	varid,
		const PIO_Offset *	start,
		const PIO_Offset *	count,
		signed char *	buf
	)

Get a muti-dimensional subset of a signed char variable.

This routine is called collectively by all tasks in the communicator ios.union_comm.

Parameters

ncid	identifies the netCDF file
varid	the variable ID number
start	an array of start indicies (must have same number of entries as variable has dimensions). If NULL, indices of 0 will be used.
count	an array of counts (must have same number of entries as variable has dimensions). If NULL, counts matching the size of the variable will be used.
buf	pointer that will get the data.

Returns

PIO_NOERR on success, error code otherwise.

Author

Ed Hartnett

PIOc_get_vara_short()

int PIOc_get_vara_short	(	int	ncid,
		int	varid,
		const PIO_Offset *	start,
		const PIO_Offset *	count,
		short *	buf
	)

Get a muti-dimensional subset of a 16-bit integer variable.

This routine is called collectively by all tasks in the communicator ios.union_comm.

Parameters

ncid	identifies the netCDF file
varid	the variable ID number
start	an array of start indicies (must have same number of entries as variable has dimensions). If NULL, indices of 0 will be used.
count	an array of counts (must have same number of entries as variable has dimensions). If NULL, counts matching the size of the variable will be used.
buf	pointer that will get the data.

Returns

PIO_NOERR on success, error code otherwise.

Author

Ed Hartnett

PIOc_get_vara_text()

int PIOc_get_vara_text	(	int	ncid,
		int	varid,
		const PIO_Offset *	start,
		const PIO_Offset *	count,
		char *	buf
	)

Get a muti-dimensional subset of a text variable.

This routine is called collectively by all tasks in the communicator ios.union_comm.

Parameters

ncid	identifies the netCDF file
varid	the variable ID number
start	an array of start indicies (must have same number of entries as variable has dimensions). If NULL, indices of 0 will be used.
count	an array of counts (must have same number of entries as variable has dimensions). If NULL, counts matching the size of the variable will be used.
buf	pointer that will get the data.

Returns

PIO_NOERR on success, error code otherwise.

Author

Ed Hartnett

PIOc_get_vara_uchar()

int PIOc_get_vara_uchar	(	int	ncid,
		int	varid,
		const PIO_Offset *	start,
		const PIO_Offset *	count,
		unsigned char *	buf
	)

Get a muti-dimensional subset of an unsigned char variable.

This routine is called collectively by all tasks in the communicator ios.union_comm.

Parameters

ncid	identifies the netCDF file
varid	the variable ID number
start	an array of start indicies (must have same number of entries as variable has dimensions). If NULL, indices of 0 will be used.
count	an array of counts (must have same number of entries as variable has dimensions). If NULL, counts matching the size of the variable will be used.
buf	pointer that will get the data.

Returns

PIO_NOERR on success, error code otherwise.

Author

Ed Hartnett

PIOc_get_vara_uint()

int PIOc_get_vara_uint	(	int	ncid,
		int	varid,
		const PIO_Offset *	start,
		const PIO_Offset *	count,
		unsigned int *	buf
	)

Get a muti-dimensional subset of an unsigned integer variable.

This routine is called collectively by all tasks in the communicator ios.union_comm.

Parameters

ncid	identifies the netCDF file
varid	the variable ID number
start	an array of start indicies (must have same number of entries as variable has dimensions). If NULL, indices of 0 will be used.
count	an array of counts (must have same number of entries as variable has dimensions). If NULL, counts matching the size of the variable will be used.
buf	pointer that will get the data.

Returns

PIO_NOERR on success, error code otherwise.

Author

Ed Hartnett

PIOc_get_vara_ulonglong()

int PIOc_get_vara_ulonglong	(	int	ncid,
		int	varid,
		const PIO_Offset *	start,
		const PIO_Offset *	count,
		unsigned long long *	buf
	)

Get a muti-dimensional subset of an unsigned 64-bit integer variable.

This routine is called collectively by all tasks in the communicator ios.union_comm.

Parameters

ncid	identifies the netCDF file
varid	the variable ID number
start	an array of start indicies (must have same number of entries as variable has dimensions). If NULL, indices of 0 will be used.
count	an array of counts (must have same number of entries as variable has dimensions). If NULL, counts matching the size of the variable will be used.
buf	pointer that will get the data.

Returns

PIO_NOERR on success, error code otherwise.

Author

Ed Hartnett

PIOc_get_vara_ushort()

int PIOc_get_vara_ushort	(	int	ncid,
		int	varid,
		const PIO_Offset *	start,
		const PIO_Offset *	count,
		unsigned short *	buf
	)

Get a muti-dimensional subset of an unsigned 16-bit integer variable.

This routine is called collectively by all tasks in the communicator ios.union_comm.

Parameters

ncid	identifies the netCDF file
varid	the variable ID number
start	an array of start indicies (must have same number of entries as variable has dimensions). If NULL, indices of 0 will be used.
count	an array of counts (must have same number of entries as variable has dimensions). If NULL, counts matching the size of the variable will be used.
buf	pointer that will get the data.

Returns

PIO_NOERR on success, error code otherwise.

Author

Ed Hartnett