Read Strided Arrays

Functions
int	PIOc_get_vars_text (int ncid, int varid, const PIO_Offset *start, const PIO_Offset *count, const PIO_Offset *stride, char *buf)
	Get strided, muti-dimensional subset of a text variable. More...
int	PIOc_get_vars_uchar (int ncid, int varid, const PIO_Offset *start, const PIO_Offset *count, const PIO_Offset *stride, unsigned char *buf)
	Get strided, muti-dimensional subset of an unsigned char variable. More...
int	PIOc_get_vars_schar (int ncid, int varid, const PIO_Offset *start, const PIO_Offset *count, const PIO_Offset *stride, signed char *buf)
	Get strided, muti-dimensional subset of a signed char variable. More...
int	PIOc_get_vars_ushort (int ncid, int varid, const PIO_Offset *start, const PIO_Offset *count, const PIO_Offset *stride, unsigned short *buf)
	Get strided, muti-dimensional subset of an unsigned 16-bit integer variable. More...
int	PIOc_get_vars_short (int ncid, int varid, const PIO_Offset *start, const PIO_Offset *count, const PIO_Offset *stride, short *buf)
	Get strided, muti-dimensional subset of a 16-bit integer variable. More...
int	PIOc_get_vars_uint (int ncid, int varid, const PIO_Offset *start, const PIO_Offset *count, const PIO_Offset *stride, unsigned int *buf)
	Get strided, muti-dimensional subset of an unsigned integer variable. More...
int	PIOc_get_vars_int (int ncid, int varid, const PIO_Offset *start, const PIO_Offset *count, const PIO_Offset *stride, int *buf)
	Get strided, muti-dimensional subset of an integer variable. More...
int	PIOc_get_vars_long (int ncid, int varid, const PIO_Offset *start, const PIO_Offset *count, const PIO_Offset *stride, long *buf)
	Get strided, muti-dimensional subset of a 64-bit int variable. More...
int	PIOc_get_vars_float (int ncid, int varid, const PIO_Offset *start, const PIO_Offset *count, const PIO_Offset *stride, float *buf)
	Get strided, muti-dimensional subset of a floating point variable. More...
int	PIOc_get_vars_double (int ncid, int varid, const PIO_Offset *start, const PIO_Offset *count, const PIO_Offset *stride, double *buf)
	Get strided, muti-dimensional subset of a 64-bit floating point variable. More...
int	PIOc_get_vars_ulonglong (int ncid, int varid, const PIO_Offset *start, const PIO_Offset *count, const PIO_Offset *stride, unsigned long long *buf)
	Get strided, muti-dimensional subset of an unsigned 64-bit int variable. More...
int	PIOc_get_vars_longlong (int ncid, int varid, const PIO_Offset *start, const PIO_Offset *count, const PIO_Offset *stride, long long *buf)
	Get strided, muti-dimensional subset of a 64-bit int variable. More...
int	PIOc_get_vars (int ncid, int varid, const PIO_Offset *start, const PIO_Offset *count, const PIO_Offset *stride, void *buf)
	Get strided, muti-dimensional subset of a variable of the same type as the variable in the file. More...

Detailed Description

Read strided arrays of data from a variable in C.

Function Documentation

PIOc_get_vars()

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

Get strided, muti-dimensional subset of a variable of 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.
stride	an array of strides (must have same number of entries as variable has dimensions). If NULL, strides of 1 will be used.
buf	pointer that will get the data.

Returns

PIO_NOERR on success, error code otherwise.

Author

Ed Hartnett

PIOc_get_vars_double()

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

Get strided, 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.
stride	an array of strides (must have same number of entries as variable has dimensions). If NULL, strides of 1 will be used.
buf	pointer that will get the data.

Returns

PIO_NOERR on success, error code otherwise.

Author

Ed Hartnett

PIOc_get_vars_float()

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

Get strided, 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.
stride	an array of strides (must have same number of entries as variable has dimensions). If NULL, strides of 1 will be used.
buf	pointer that will get the data.

Returns

PIO_NOERR on success, error code otherwise.

Author

Ed Hartnett

PIOc_get_vars_int()

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

Get strided, 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.
stride	an array of strides (must have same number of entries as variable has dimensions). If NULL, strides of 1 will be used.
buf	pointer that will get the data.

Returns

PIO_NOERR on success, error code otherwise.

Author

Ed Hartnett

PIOc_get_vars_long()

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

Get strided, muti-dimensional subset of a 64-bit int 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.
stride	an array of strides (must have same number of entries as variable has dimensions). If NULL, strides of 1 will be used.
buf	pointer that will get the data.

Returns

PIO_NOERR on success, error code otherwise.

Author

Ed Hartnett

PIOc_get_vars_longlong()

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

Get strided, muti-dimensional subset of a 64-bit int 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.
stride	an array of strides (must have same number of entries as variable has dimensions). If NULL, strides of 1 will be used.
buf	pointer that will get the data.

Returns

PIO_NOERR on success, error code otherwise.

Author

Ed Hartnett

PIOc_get_vars_schar()

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

Get strided, 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.
stride	an array of strides (must have same number of entries as variable has dimensions). If NULL, strides of 1 will be used.
buf	pointer that will get the data.

Returns

PIO_NOERR on success, error code otherwise.

Author

Ed Hartnett

PIOc_get_vars_short()

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

Get strided, 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.
stride	an array of strides (must have same number of entries as variable has dimensions). If NULL, strides of 1 will be used.
buf	pointer that will get the data.

Returns

PIO_NOERR on success, error code otherwise.

Author

Ed Hartnett

PIOc_get_vars_text()

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

Get strided, 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.
stride	an array of strides (must have same number of entries as variable has dimensions). If NULL, strides of 1 will be used.
buf	pointer that will get the data.

Returns

PIO_NOERR on success, error code otherwise.

Author

Ed Hartnett

PIOc_get_vars_uchar()

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

Get strided, 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.
stride	an array of strides (must have same number of entries as variable has dimensions). If NULL, strides of 1 will be used.
buf	pointer that will get the data.

Returns

PIO_NOERR on success, error code otherwise.

Author

Ed Hartnett

PIOc_get_vars_uint()

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

Get strided, 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.
stride	an array of strides (must have same number of entries as variable has dimensions). If NULL, strides of 1 will be used.
buf	pointer that will get the data.

Returns

PIO_NOERR on success, error code otherwise.

Author

Ed Hartnett

PIOc_get_vars_ulonglong()

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

Get strided, muti-dimensional subset of an unsigned 64-bit int 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.
stride	an array of strides (must have same number of entries as variable has dimensions). If NULL, strides of 1 will be used.
buf	pointer that will get the data.

Returns

PIO_NOERR on success, error code otherwise.

Author

Ed Hartnett

PIOc_get_vars_ushort()

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

Get strided, 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.
stride	an array of strides (must have same number of entries as variable has dimensions). If NULL, strides of 1 will be used.
buf	pointer that will get the data.

Returns

PIO_NOERR on success, error code otherwise.

Author

Ed Hartnett