PIO  2.5.4
Functions
Read Entire Variable

Functions

int PIOc_get_var_text (int ncid, int varid, char *buf)
 Get all data of a text variable. More...
 
int PIOc_get_var_uchar (int ncid, int varid, unsigned char *buf)
 Get all data of an unsigned char variable. More...
 
int PIOc_get_var_schar (int ncid, int varid, signed char *buf)
 Get all data of a signed char variable. More...
 
int PIOc_get_var_ushort (int ncid, int varid, unsigned short *buf)
 Get all data of an unsigned 16-bit integer variable. More...
 
int PIOc_get_var_short (int ncid, int varid, short *buf)
 Get all data of a 16-bit integer variable. More...
 
int PIOc_get_var_uint (int ncid, int varid, unsigned int *buf)
 Get all data of an unsigned integer variable. More...
 
int PIOc_get_var_int (int ncid, int varid, int *buf)
 Get all data of an integer variable. More...
 
int PIOc_get_var_long (int ncid, int varid, long *buf)
 Get all data of a 64-bit integer variable. More...
 
int PIOc_get_var_float (int ncid, int varid, float *buf)
 Get all data of a floating point variable. More...
 
int PIOc_get_var_double (int ncid, int varid, double *buf)
 Get all data of a 64-bit floating point variable. More...
 
int PIOc_get_var_ulonglong (int ncid, int varid, unsigned long long *buf)
 Get all data of an unsigned 64-bit integer variable. More...
 
int PIOc_get_var_longlong (int ncid, int varid, long long *buf)
 Get all data of a 64-bit integer variable. More...
 
int PIOc_get_var (int ncid, int varid, void *buf)
 Get all data from a variable the same type as the variable in the file. More...
 

Detailed Description

Read the entire variable at one time into an array in C.

Function Documentation

◆ PIOc_get_var()

int PIOc_get_var ( int  ncid,
int  varid,
void *  buf 
)

Get all data from 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
ncididentifies the netCDF file
varidthe variable ID number
bufpointer that will get the data.
Returns
PIO_NOERR on success, error code otherwise.
Author
Ed Hartnett

◆ PIOc_get_var_double()

int PIOc_get_var_double ( int  ncid,
int  varid,
double *  buf 
)

Get all data of a 64-bit floating point variable.

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

Parameters
ncididentifies the netCDF file
varidthe variable ID number
bufpointer that will get the data.
Returns
PIO_NOERR on success, error code otherwise.
Author
Ed Hartnett

◆ PIOc_get_var_float()

int PIOc_get_var_float ( int  ncid,
int  varid,
float *  buf 
)

Get all data of a floating point variable.

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

Parameters
ncididentifies the netCDF file
varidthe variable ID number
bufpointer that will get the data.
Returns
PIO_NOERR on success, error code otherwise.
Author
Ed Hartnett

◆ PIOc_get_var_int()

int PIOc_get_var_int ( int  ncid,
int  varid,
int *  buf 
)

Get all data of an integer variable.

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

Parameters
ncididentifies the netCDF file
varidthe variable ID number
bufpointer that will get the data.
Returns
PIO_NOERR on success, error code otherwise.
Author
Ed Hartnett

◆ PIOc_get_var_long()

int PIOc_get_var_long ( int  ncid,
int  varid,
long *  buf 
)

Get all data of a 64-bit integer variable.

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

Parameters
ncididentifies the netCDF file
varidthe variable ID number
bufpointer that will get the data.
Returns
PIO_NOERR on success, error code otherwise.
Author
Ed Hartnett

◆ PIOc_get_var_longlong()

int PIOc_get_var_longlong ( int  ncid,
int  varid,
long long *  buf 
)

Get all data of a 64-bit integer variable.

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

Parameters
ncididentifies the netCDF file
varidthe variable ID number
bufpointer that will get the data.
Returns
PIO_NOERR on success, error code otherwise.
Author
Ed Hartnett

◆ PIOc_get_var_schar()

int PIOc_get_var_schar ( int  ncid,
int  varid,
signed char *  buf 
)

Get all data of a signed char variable.

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

Parameters
ncididentifies the netCDF file
varidthe variable ID number
bufpointer that will get the data.
Returns
PIO_NOERR on success, error code otherwise.
Author
Ed Hartnett

◆ PIOc_get_var_short()

int PIOc_get_var_short ( int  ncid,
int  varid,
short *  buf 
)

Get all data of a 16-bit integer variable.

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

Parameters
ncididentifies the netCDF file
varidthe variable ID number
bufpointer that will get the data.
Returns
PIO_NOERR on success, error code otherwise.
Author
Ed Hartnett

◆ PIOc_get_var_text()

int PIOc_get_var_text ( int  ncid,
int  varid,
char *  buf 
)

Get all data of a text variable.

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

Parameters
ncididentifies the netCDF file
varidthe variable ID number
bufpointer that will get the data.
Returns
PIO_NOERR on success, error code otherwise.
Author
Ed Hartnett

◆ PIOc_get_var_uchar()

int PIOc_get_var_uchar ( int  ncid,
int  varid,
unsigned char *  buf 
)

Get all data of an unsigned char variable.

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

Parameters
ncididentifies the netCDF file
varidthe variable ID number
bufpointer that will get the data.
Returns
PIO_NOERR on success, error code otherwise.
Author
Ed Hartnett

◆ PIOc_get_var_uint()

int PIOc_get_var_uint ( int  ncid,
int  varid,
unsigned int *  buf 
)

Get all data of an unsigned integer variable.

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

Parameters
ncididentifies the netCDF file
varidthe variable ID number
bufpointer that will get the data.
Returns
PIO_NOERR on success, error code otherwise.
Author
Ed Hartnett

◆ PIOc_get_var_ulonglong()

int PIOc_get_var_ulonglong ( int  ncid,
int  varid,
unsigned long long *  buf 
)

Get all data of an unsigned 64-bit integer variable.

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

Parameters
ncididentifies the netCDF file
varidthe variable ID number
bufpointer that will get the data.
Returns
PIO_NOERR on success, error code otherwise.
Author
Ed Hartnett

◆ PIOc_get_var_ushort()

int PIOc_get_var_ushort ( int  ncid,
int  varid,
unsigned short *  buf 
)

Get all data of an unsigned 16-bit integer variable.

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

Parameters
ncididentifies the netCDF file
varidthe variable ID number
bufpointer that will get the data.
Returns
PIO_NOERR on success, error code otherwise.
Author
Ed Hartnett