SCORPIO  1.7.0
Functions/Subroutines
PIO_get_att

Read ("Get") a variable attribute. More...

Functions/Subroutines

integer function spio_get_att::pio_get_att_file_vid_0d_text (file, varid, attname, attval)
 Read/Get a string attribute associated with a variable in a file. More...
 
integer function spio_get_att::pio_get_att_file_vid_1d_text (file, varid, attname, attval)
 Read/Get a string attribute associated with a variable in a file. More...
 
integer function spio_get_att::pio_get_att_fh_vid_0d_text (fh, varid, attname, attval)
 Read/get a string attribute (or array of attributes) associated with a variable in a file. More...
 
integer function spio_get_att::pio_get_att_fh_vid_1d_text (fh, varid, attname, attval)
 Read/get a string attribute (or array of attributes) associated with a variable in a file. More...
 
integer function spio_get_att::pio_get_att_file_vdesc_0d_text (file, vdesc, attname, attval)
 Read/get a string attribute (or array of attributes) associated with a variable in a file. More...
 
integer function spio_get_att::pio_get_att_file_vdesc_1d_text (file, vdesc, attname, attval)
 Read/get a string attribute (or array of attributes) associated with a variable in a file. More...
 
integer function spio_get_att::pio_get_att_file_vid_0d_int (file, varid, attname, attval)
 Read/Get an attribute (or an array of attributes) associated with a variable in a file. More...
 
integer function spio_get_att::pio_get_att_file_vid_1d_int (file, varid, attname, attval)
 Read/Get an attribute (or an array of attributes) associated with a variable in a file. More...
 
integer function spio_get_att::pio_get_att_file_vid_0d_real (file, varid, attname, attval)
 Read/Get an attribute (or an array of attributes) associated with a variable in a file. More...
 
integer function spio_get_att::pio_get_att_file_vid_1d_real (file, varid, attname, attval)
 Read/Get an attribute (or an array of attributes) associated with a variable in a file. More...
 
integer function spio_get_att::pio_get_att_file_vid_0d_double (file, varid, attname, attval)
 Read/Get an attribute (or an array of attributes) associated with a variable in a file. More...
 
integer function spio_get_att::pio_get_att_file_vid_1d_double (file, varid, attname, attval)
 Read/Get an attribute (or an array of attributes) associated with a variable in a file. More...
 
integer function spio_get_att::pio_get_att_fh_vid_0d_int (fh, varid, attname, attval)
 Read/Get an attribute (or an array of attributes) associated with a variable in a file. More...
 
integer function spio_get_att::pio_get_att_fh_vid_1d_int (fh, varid, attname, attval)
 Read/Get an attribute (or an array of attributes) associated with a variable in a file. More...
 
integer function spio_get_att::pio_get_att_fh_vid_0d_real (fh, varid, attname, attval)
 Read/Get an attribute (or an array of attributes) associated with a variable in a file. More...
 
integer function spio_get_att::pio_get_att_fh_vid_1d_real (fh, varid, attname, attval)
 Read/Get an attribute (or an array of attributes) associated with a variable in a file. More...
 
integer function spio_get_att::pio_get_att_fh_vid_0d_double (fh, varid, attname, attval)
 Read/Get an attribute (or an array of attributes) associated with a variable in a file. More...
 
integer function spio_get_att::pio_get_att_fh_vid_1d_double (fh, varid, attname, attval)
 Read/Get an attribute (or an array of attributes) associated with a variable in a file. More...
 
integer function spio_get_att::pio_get_att_file_vdesc_0d_int (file, vdesc, attname, attval)
 Read/Get an attribute (or an array of attributes) associated with a variable in a file. More...
 
integer function spio_get_att::pio_get_att_file_vdesc_1d_int (file, vdesc, attname, attval)
 Read/Get an attribute (or an array of attributes) associated with a variable in a file. More...
 
integer function spio_get_att::pio_get_att_file_vdesc_0d_real (file, vdesc, attname, attval)
 Read/Get an attribute (or an array of attributes) associated with a variable in a file. More...
 
integer function spio_get_att::pio_get_att_file_vdesc_1d_real (file, vdesc, attname, attval)
 Read/Get an attribute (or an array of attributes) associated with a variable in a file. More...
 
integer function spio_get_att::pio_get_att_file_vdesc_0d_double (file, vdesc, attname, attval)
 Read/Get an attribute (or an array of attributes) associated with a variable in a file. More...
 
integer function spio_get_att::pio_get_att_file_vdesc_1d_double (file, vdesc, attname, attval)
 Read/Get an attribute (or an array of attributes) associated with a variable in a file. More...
 

Detailed Description

Read ("Get") a variable attribute.

This API can be used to read attributes associated with variables in a file. The variable attributes supported are scalar and a 1D array of values. These arrays/scalars have the same data across all the MPI processes in the I/O system (where the file was opened/created).

This API is a collective call on the I/O system associated with the file

Function/Subroutine Documentation

◆ pio_get_att_fh_vid_0d_double()

integer function spio_get_att::pio_get_att_fh_vid_0d_double ( integer, intent(in)  fh,
integer, intent(in)  varid,
character(len=*), intent(in)  attname,
real(r8), intent(out)  attval 
)

Read/Get an attribute (or an array of attributes) associated with a variable in a file.

Parameters
[in]fhThe file handle/id
[in]varidThe id of the variable
[in]attnameThe name of the attribute
[out]attvalThe attribute value (a scalar value or an array of values) is read into this arg
Return values
ierr: The error return code. Set to PIO_NOERR on success, or an error code otherwise (See PIO_seterrorhandling for more information on how to customize/set error handling)

◆ pio_get_att_fh_vid_0d_int()

integer function spio_get_att::pio_get_att_fh_vid_0d_int ( integer, intent(in)  fh,
integer, intent(in)  varid,
character(len=*), intent(in)  attname,
integer(i4), intent(out)  attval 
)

Read/Get an attribute (or an array of attributes) associated with a variable in a file.

Parameters
[in]fhThe file handle/id
[in]varidThe id of the variable
[in]attnameThe name of the attribute
[out]attvalThe attribute value (a scalar value or an array of values) is read into this arg
Return values
ierr: The error return code. Set to PIO_NOERR on success, or an error code otherwise (See PIO_seterrorhandling for more information on how to customize/set error handling)

◆ pio_get_att_fh_vid_0d_real()

integer function spio_get_att::pio_get_att_fh_vid_0d_real ( integer, intent(in)  fh,
integer, intent(in)  varid,
character(len=*), intent(in)  attname,
real(r4), intent(out)  attval 
)

Read/Get an attribute (or an array of attributes) associated with a variable in a file.

Parameters
[in]fhThe file handle/id
[in]varidThe id of the variable
[in]attnameThe name of the attribute
[out]attvalThe attribute value (a scalar value or an array of values) is read into this arg
Return values
ierr: The error return code. Set to PIO_NOERR on success, or an error code otherwise (See PIO_seterrorhandling for more information on how to customize/set error handling)

◆ pio_get_att_fh_vid_0d_text()

integer function spio_get_att::pio_get_att_fh_vid_0d_text ( integer, intent(in)  fh,
integer, intent(in)  varid,
character(len=*), intent(in)  attname,
character(len=*), intent(out)  attval 
)

Read/get a string attribute (or array of attributes) associated with a variable in a file.

Parameters
[in]fhThe file handle/id
[in]varidThe id of the variable
[in]attnameThe name of the attribute
[out]attvalThe attribute value (string or an array of strings) is read into this arg
Return values
ierr: The error return code. Set to PIO_NOERR on success, or an error code otherwise (See PIO_seterrorhandling for more information on how to customize/set error handling)

◆ pio_get_att_fh_vid_1d_double()

integer function spio_get_att::pio_get_att_fh_vid_1d_double ( integer, intent(in)  fh,
integer, intent(in)  varid,
character(len=*), intent(in)  attname,
real(r8), dimension(:), intent(out)  attval 
)

Read/Get an attribute (or an array of attributes) associated with a variable in a file.

Parameters
[in]fhThe file handle/id
[in]varidThe id of the variable
[in]attnameThe name of the attribute
[out]attvalThe attribute value (a scalar value or an array of values) is read into this arg
Return values
ierr: The error return code. Set to PIO_NOERR on success, or an error code otherwise (See PIO_seterrorhandling for more information on how to customize/set error handling)

◆ pio_get_att_fh_vid_1d_int()

integer function spio_get_att::pio_get_att_fh_vid_1d_int ( integer, intent(in)  fh,
integer, intent(in)  varid,
character(len=*), intent(in)  attname,
integer(i4), dimension(:), intent(out)  attval 
)

Read/Get an attribute (or an array of attributes) associated with a variable in a file.

Parameters
[in]fhThe file handle/id
[in]varidThe id of the variable
[in]attnameThe name of the attribute
[out]attvalThe attribute value (a scalar value or an array of values) is read into this arg
Return values
ierr: The error return code. Set to PIO_NOERR on success, or an error code otherwise (See PIO_seterrorhandling for more information on how to customize/set error handling)

◆ pio_get_att_fh_vid_1d_real()

integer function spio_get_att::pio_get_att_fh_vid_1d_real ( integer, intent(in)  fh,
integer, intent(in)  varid,
character(len=*), intent(in)  attname,
real(r4), dimension(:), intent(out)  attval 
)

Read/Get an attribute (or an array of attributes) associated with a variable in a file.

Parameters
[in]fhThe file handle/id
[in]varidThe id of the variable
[in]attnameThe name of the attribute
[out]attvalThe attribute value (a scalar value or an array of values) is read into this arg
Return values
ierr: The error return code. Set to PIO_NOERR on success, or an error code otherwise (See PIO_seterrorhandling for more information on how to customize/set error handling)

◆ pio_get_att_fh_vid_1d_text()

integer function spio_get_att::pio_get_att_fh_vid_1d_text ( integer, intent(in)  fh,
integer, intent(in)  varid,
character(len=*), intent(in)  attname,
character(len=*), dimension(:), intent(out)  attval 
)

Read/get a string attribute (or array of attributes) associated with a variable in a file.

Parameters
[in]fhThe file handle/id
[in]varidThe id of the variable
[in]attnameThe name of the attribute
[out]attvalThe attribute value (string or an array of strings) is read into this arg
Return values
ierr: The error return code. Set to PIO_NOERR on success, or an error code otherwise (See PIO_seterrorhandling for more information on how to customize/set error handling)

◆ pio_get_att_file_vdesc_0d_double()

integer function spio_get_att::pio_get_att_file_vdesc_0d_double ( type(file_desc_t), intent(in)  file,
type(var_desc_t), intent(in)  vdesc,
character(len=*), intent(in)  attname,
real(r8), intent(out)  attval 
)

Read/Get an attribute (or an array of attributes) associated with a variable in a file.

Parameters
[in]fileThe file handle. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[in]attnameThe name of the attribute
[out]attvalThe attribute value (a scalar value or an array of values) is read into this arg
Return values
ierr: The error return code. Set to PIO_NOERR on success, or an error code otherwise (See PIO_seterrorhandling for more information on how to customize/set error handling)

◆ pio_get_att_file_vdesc_0d_int()

integer function spio_get_att::pio_get_att_file_vdesc_0d_int ( type(file_desc_t), intent(in)  file,
type(var_desc_t), intent(in)  vdesc,
character(len=*), intent(in)  attname,
integer(i4), intent(out)  attval 
)

Read/Get an attribute (or an array of attributes) associated with a variable in a file.

Parameters
[in]fileThe file handle. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[in]attnameThe name of the attribute
[out]attvalThe attribute value (a scalar value or an array of values) is read into this arg
Return values
ierr: The error return code. Set to PIO_NOERR on success, or an error code otherwise (See PIO_seterrorhandling for more information on how to customize/set error handling)

◆ pio_get_att_file_vdesc_0d_real()

integer function spio_get_att::pio_get_att_file_vdesc_0d_real ( type(file_desc_t), intent(in)  file,
type(var_desc_t), intent(in)  vdesc,
character(len=*), intent(in)  attname,
real(r4), intent(out)  attval 
)

Read/Get an attribute (or an array of attributes) associated with a variable in a file.

Parameters
[in]fileThe file handle. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[in]attnameThe name of the attribute
[out]attvalThe attribute value (a scalar value or an array of values) is read into this arg
Return values
ierr: The error return code. Set to PIO_NOERR on success, or an error code otherwise (See PIO_seterrorhandling for more information on how to customize/set error handling)

◆ pio_get_att_file_vdesc_0d_text()

integer function spio_get_att::pio_get_att_file_vdesc_0d_text ( type(file_desc_t), intent(in)  file,
type(var_desc_t), intent(in)  vdesc,
character(len=*), intent(in)  attname,
character(len=*), intent(out)  attval 
)

Read/get a string attribute (or array of attributes) associated with a variable in a file.

Parameters
[in]fileThe file handle. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[in]attnameThe name of the attribute
[out]attvalThe attribute value (string or an array of strings) is read into this arg
Return values
ierr: The error return code. Set to PIO_NOERR on success, or an error code otherwise (See PIO_seterrorhandling for more information on how to customize/set error handling)

◆ pio_get_att_file_vdesc_1d_double()

integer function spio_get_att::pio_get_att_file_vdesc_1d_double ( type(file_desc_t), intent(in)  file,
type(var_desc_t), intent(in)  vdesc,
character(len=*), intent(in)  attname,
real(r8), dimension(:), intent(out)  attval 
)

Read/Get an attribute (or an array of attributes) associated with a variable in a file.

Parameters
[in]fileThe file handle. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[in]attnameThe name of the attribute
[out]attvalThe attribute value (a scalar value or an array of values) is read into this arg
Return values
ierr: The error return code. Set to PIO_NOERR on success, or an error code otherwise (See PIO_seterrorhandling for more information on how to customize/set error handling)

◆ pio_get_att_file_vdesc_1d_int()

integer function spio_get_att::pio_get_att_file_vdesc_1d_int ( type(file_desc_t), intent(in)  file,
type(var_desc_t), intent(in)  vdesc,
character(len=*), intent(in)  attname,
integer(i4), dimension(:), intent(out)  attval 
)

Read/Get an attribute (or an array of attributes) associated with a variable in a file.

Parameters
[in]fileThe file handle. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[in]attnameThe name of the attribute
[out]attvalThe attribute value (a scalar value or an array of values) is read into this arg
Return values
ierr: The error return code. Set to PIO_NOERR on success, or an error code otherwise (See PIO_seterrorhandling for more information on how to customize/set error handling)

◆ pio_get_att_file_vdesc_1d_real()

integer function spio_get_att::pio_get_att_file_vdesc_1d_real ( type(file_desc_t), intent(in)  file,
type(var_desc_t), intent(in)  vdesc,
character(len=*), intent(in)  attname,
real(r4), dimension(:), intent(out)  attval 
)

Read/Get an attribute (or an array of attributes) associated with a variable in a file.

Parameters
[in]fileThe file handle. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[in]attnameThe name of the attribute
[out]attvalThe attribute value (a scalar value or an array of values) is read into this arg
Return values
ierr: The error return code. Set to PIO_NOERR on success, or an error code otherwise (See PIO_seterrorhandling for more information on how to customize/set error handling)

◆ pio_get_att_file_vdesc_1d_text()

integer function spio_get_att::pio_get_att_file_vdesc_1d_text ( type(file_desc_t), intent(in)  file,
type(var_desc_t), intent(in)  vdesc,
character(len=*), intent(in)  attname,
character(len=*), dimension(:), intent(out)  attval 
)

Read/get a string attribute (or array of attributes) associated with a variable in a file.

Parameters
[in]fileThe file handle. File descriptor structure. This structure holds information associated with each open file
[in]vdescThe handle to the variable. Variable description structure.
[in]attnameThe name of the attribute
[out]attvalThe attribute value (string or an array of strings) is read into this arg
Return values
ierr: The error return code. Set to PIO_NOERR on success, or an error code otherwise (See PIO_seterrorhandling for more information on how to customize/set error handling)

◆ pio_get_att_file_vid_0d_double()

integer function spio_get_att::pio_get_att_file_vid_0d_double ( type(file_desc_t), intent(in)  file,
integer, intent(in)  varid,
character(len=*), intent(in)  attname,
real(r8), intent(out), target  attval 
)

Read/Get an attribute (or an array of attributes) associated with a variable in a file.

Parameters
[in]fileThe file handle. File descriptor structure. This structure holds information associated with each open file
[in]varidThe id of the variable
[in]attnameThe name of the attribute
[out]attvalThe attribute value (a scalar value or an array of values) is read into this arg
Return values
ierr: The error return code. Set to PIO_NOERR on success, or an error code otherwise (See PIO_seterrorhandling for more information on how to customize/set error handling)

◆ pio_get_att_file_vid_0d_int()

integer function spio_get_att::pio_get_att_file_vid_0d_int ( type(file_desc_t), intent(in)  file,
integer, intent(in)  varid,
character(len=*), intent(in)  attname,
integer(i4), intent(out), target  attval 
)

Read/Get an attribute (or an array of attributes) associated with a variable in a file.

Parameters
[in]fileThe file handle. File descriptor structure. This structure holds information associated with each open file
[in]varidThe id of the variable
[in]attnameThe name of the attribute
[out]attvalThe attribute value (a scalar value or an array of values) is read into this arg
Return values
ierr: The error return code. Set to PIO_NOERR on success, or an error code otherwise (See PIO_seterrorhandling for more information on how to customize/set error handling)

◆ pio_get_att_file_vid_0d_real()

integer function spio_get_att::pio_get_att_file_vid_0d_real ( type(file_desc_t), intent(in)  file,
integer, intent(in)  varid,
character(len=*), intent(in)  attname,
real(r4), intent(out), target  attval 
)

Read/Get an attribute (or an array of attributes) associated with a variable in a file.

Parameters
[in]fileThe file handle. File descriptor structure. This structure holds information associated with each open file
[in]varidThe id of the variable
[in]attnameThe name of the attribute
[out]attvalThe attribute value (a scalar value or an array of values) is read into this arg
Return values
ierr: The error return code. Set to PIO_NOERR on success, or an error code otherwise (See PIO_seterrorhandling for more information on how to customize/set error handling)

◆ pio_get_att_file_vid_0d_text()

integer function spio_get_att::pio_get_att_file_vid_0d_text ( type(file_desc_t), intent(in)  file,
integer, intent(in)  varid,
character(len=*), intent(in)  attname,
character(len=*), intent(out)  attval 
)

Read/Get a string attribute associated with a variable in a file.

Parameters
[in]fileThe file handle. File descriptor structure. This structure holds information associated with each open file
[in]varidThe id of the variable
[in]attnameThe name of the attribute
[out]attvalThe attribute value (string or an array of strings) is read into this arg
Return values
ierr: The error return code. Set to PIO_NOERR on success, or an error code otherwise (See PIO_seterrorhandling for more information on how to customize/set error handling)

◆ pio_get_att_file_vid_1d_double()

integer function spio_get_att::pio_get_att_file_vid_1d_double ( type(file_desc_t), intent(in)  file,
integer, intent(in)  varid,
character(len=*), intent(in)  attname,
real(r8), dimension(:), intent(out), target  attval 
)

Read/Get an attribute (or an array of attributes) associated with a variable in a file.

Parameters
[in]fileThe file handle. File descriptor structure. This structure holds information associated with each open file
[in]varidThe id of the variable
[in]attnameThe name of the attribute
[out]attvalThe attribute value (a scalar value or an array of values) is read into this arg
Return values
ierr: The error return code. Set to PIO_NOERR on success, or an error code otherwise (See PIO_seterrorhandling for more information on how to customize/set error handling)

◆ pio_get_att_file_vid_1d_int()

integer function spio_get_att::pio_get_att_file_vid_1d_int ( type(file_desc_t), intent(in)  file,
integer, intent(in)  varid,
character(len=*), intent(in)  attname,
integer(i4), dimension(:), intent(out), target  attval 
)

Read/Get an attribute (or an array of attributes) associated with a variable in a file.

Parameters
[in]fileThe file handle. File descriptor structure. This structure holds information associated with each open file
[in]varidThe id of the variable
[in]attnameThe name of the attribute
[out]attvalThe attribute value (a scalar value or an array of values) is read into this arg
Return values
ierr: The error return code. Set to PIO_NOERR on success, or an error code otherwise (See PIO_seterrorhandling for more information on how to customize/set error handling)

◆ pio_get_att_file_vid_1d_real()

integer function spio_get_att::pio_get_att_file_vid_1d_real ( type(file_desc_t), intent(in)  file,
integer, intent(in)  varid,
character(len=*), intent(in)  attname,
real(r4), dimension(:), intent(out), target  attval 
)

Read/Get an attribute (or an array of attributes) associated with a variable in a file.

Parameters
[in]fileThe file handle. File descriptor structure. This structure holds information associated with each open file
[in]varidThe id of the variable
[in]attnameThe name of the attribute
[out]attvalThe attribute value (a scalar value or an array of values) is read into this arg
Return values
ierr: The error return code. Set to PIO_NOERR on success, or an error code otherwise (See PIO_seterrorhandling for more information on how to customize/set error handling)

◆ pio_get_att_file_vid_1d_text()

integer function spio_get_att::pio_get_att_file_vid_1d_text ( type(file_desc_t), intent(in)  file,
integer, intent(in)  varid,
character(len=*), intent(in)  attname,
character(len=*), dimension(:), intent(out)  attval 
)

Read/Get a string attribute associated with a variable in a file.

Parameters
[in]fileThe file handle. File descriptor structure. This structure holds information associated with each open file
[in]varidThe id of the variable
[in]attnameThe name of the attribute
[out]attvalThe attribute value (string or an array of strings) is read into this arg
Return values
ierr: The error return code. Set to PIO_NOERR on success, or an error code otherwise (See PIO_seterrorhandling for more information on how to customize/set error handling)