PIO  2.5.4
Functions
Read One Value

Functions

int PIOc_get_var1_text (int ncid, int varid, const PIO_Offset *index, char *buf)
 Get one value of a text variable. More...
 
int PIOc_get_var1_uchar (int ncid, int varid, const PIO_Offset *index, unsigned char *buf)
 Get one value of an unsinged char variable. More...
 
int PIOc_get_var1_schar (int ncid, int varid, const PIO_Offset *index, signed char *buf)
 Get one value of a signed char variable. More...
 
int PIOc_get_var1_ushort (int ncid, int varid, const PIO_Offset *index, unsigned short *buf)
 Get one value of an unsigned 16-bit integer variable. More...
 
int PIOc_get_var1_short (int ncid, int varid, const PIO_Offset *index, short *buf)
 Get one value of a 16-bit integer variable. More...
 
int PIOc_get_var1_uint (int ncid, int varid, const PIO_Offset *index, unsigned int *buf)
 Get one value of an unsigned integer variable. More...
 
int PIOc_get_var1_long (int ncid, int varid, const PIO_Offset *index, long *buf)
 Get one value of a 64-bit integer variable. More...
 
int PIOc_get_var1_int (int ncid, int varid, const PIO_Offset *index, int *buf)
 Get one value of an integer variable. More...
 
int PIOc_get_var1_float (int ncid, int varid, const PIO_Offset *index, float *buf)
 Get one value of a floating point variable. More...
 
int PIOc_get_var1_double (int ncid, int varid, const PIO_Offset *index, double *buf)
 Get one value of a 64-bit floating point variable. More...
 
int PIOc_get_var1_ulonglong (int ncid, int varid, const PIO_Offset *index, unsigned long long *buf)
 Get one value of an unsigned 64-bit integer variable. More...
 
int PIOc_get_var1_longlong (int ncid, int varid, const PIO_Offset *index, long long *buf)
 Get one value of a 64-bit integer variable. More...
 
int PIOc_get_var1 (int ncid, int varid, const PIO_Offset *index, void *buf)
 Get one value from a variable the same type as the variable in the file. More...
 

Detailed Description

Read one value from a variable in C.

Function Documentation

◆ PIOc_get_var1()

int PIOc_get_var1 ( int  ncid,
int  varid,
const PIO_Offset index,
void *  buf 
)

Get one value 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
indexan array of start indicies (must have same number of entries as variable has dimensions). If NULL, indices of 0 will be used.
bufpointer that will get the data.
Returns
PIO_NOERR on success, error code otherwise.
Author
Ed Hartnett

◆ PIOc_get_var1_double()

int PIOc_get_var1_double ( int  ncid,
int  varid,
const PIO_Offset index,
double *  buf 
)

Get one value 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
indexan array of start indicies (must have same number of entries as variable has dimensions). If NULL, indices of 0 will be used.
bufpointer that will get the data.
Returns
PIO_NOERR on success, error code otherwise.
Author
Ed Hartnett

◆ PIOc_get_var1_float()

int PIOc_get_var1_float ( int  ncid,
int  varid,
const PIO_Offset index,
float *  buf 
)

Get one value 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
indexan array of start indicies (must have same number of entries as variable has dimensions). If NULL, indices of 0 will be used.
bufpointer that will get the data.
Returns
PIO_NOERR on success, error code otherwise.
Author
Ed Hartnett

◆ PIOc_get_var1_int()

int PIOc_get_var1_int ( int  ncid,
int  varid,
const PIO_Offset index,
int *  buf 
)

Get one value 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
indexan array of start indicies (must have same number of entries as variable has dimensions). If NULL, indices of 0 will be used.
bufpointer that will get the data.
Returns
PIO_NOERR on success, error code otherwise.
Author
Ed Hartnett

◆ PIOc_get_var1_long()

int PIOc_get_var1_long ( int  ncid,
int  varid,
const PIO_Offset index,
long *  buf 
)

Get one value 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
indexan array of start indicies (must have same number of entries as variable has dimensions). If NULL, indices of 0 will be used.
bufpointer that will get the data.
Returns
PIO_NOERR on success, error code otherwise.
Author
Ed Hartnett

◆ PIOc_get_var1_longlong()

int PIOc_get_var1_longlong ( int  ncid,
int  varid,
const PIO_Offset index,
long long *  buf 
)

Get one value 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
indexan array of start indicies (must have same number of entries as variable has dimensions). If NULL, indices of 0 will be used.
bufpointer that will get the data.
Returns
PIO_NOERR on success, error code otherwise.
Author
Ed Hartnett

◆ PIOc_get_var1_schar()

int PIOc_get_var1_schar ( int  ncid,
int  varid,
const PIO_Offset index,
signed char *  buf 
)

Get one value 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
indexan array of start indicies (must have same number of entries as variable has dimensions). If NULL, indices of 0 will be used.
bufpointer that will get the data.
Returns
PIO_NOERR on success, error code otherwise.
Author
Ed Hartnett

◆ PIOc_get_var1_short()

int PIOc_get_var1_short ( int  ncid,
int  varid,
const PIO_Offset index,
short *  buf 
)

Get one value 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
indexan array of start indicies (must have same number of entries as variable has dimensions). If NULL, indices of 0 will be used.
bufpointer that will get the data.
Returns
PIO_NOERR on success, error code otherwise.
Author
Ed Hartnett

◆ PIOc_get_var1_text()

int PIOc_get_var1_text ( int  ncid,
int  varid,
const PIO_Offset index,
char *  buf 
)

Get one value 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
indexan array of start indicies (must have same number of entries as variable has dimensions). If NULL, indices of 0 will be used.
bufpointer that will get the data.
Returns
PIO_NOERR on success, error code otherwise.
Author
Ed Hartnett

◆ PIOc_get_var1_uchar()

int PIOc_get_var1_uchar ( int  ncid,
int  varid,
const PIO_Offset index,
unsigned char *  buf 
)

Get one value of an unsinged 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
indexan array of start indicies (must have same number of entries as variable has dimensions). If NULL, indices of 0 will be used.
bufpointer that will get the data.
Returns
PIO_NOERR on success, error code otherwise.
Author
Ed Hartnett

◆ PIOc_get_var1_uint()

int PIOc_get_var1_uint ( int  ncid,
int  varid,
const PIO_Offset index,
unsigned int *  buf 
)

Get one value 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
indexan array of start indicies (must have same number of entries as variable has dimensions). If NULL, indices of 0 will be used.
bufpointer that will get the data.
Returns
PIO_NOERR on success, error code otherwise.
Author
Ed Hartnett

◆ PIOc_get_var1_ulonglong()

int PIOc_get_var1_ulonglong ( int  ncid,
int  varid,
const PIO_Offset index,
unsigned long long *  buf 
)

Get one value 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
indexan array of start indicies (must have same number of entries as variable has dimensions). If NULL, indices of 0 will be used.
bufpointer that will get the data.
Returns
PIO_NOERR on success, error code otherwise.
Author
Ed Hartnett

◆ PIOc_get_var1_ushort()

int PIOc_get_var1_ushort ( int  ncid,
int  varid,
const PIO_Offset index,
unsigned short *  buf 
)

Get one value 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
indexan array of start indicies (must have same number of entries as variable has dimensions). If NULL, indices of 0 will be used.
bufpointer that will get the data.
Returns
PIO_NOERR on success, error code otherwise.
Author
Ed Hartnett