SCORPIO  1.7.0
Functions/Subroutines
PIO_put_att

Write ("Put") a variable attribute. More...

Functions/Subroutines

integer function spio_put_att::pio_put_att_file_vid_0d_text (file, varid, attname, attval)
 Write/Put a string attribute associated with a variable in a file. More...
 
integer function spio_put_att::pio_put_att_file_vid_1d_text (file, varid, attname, attval)
 Write/Put a string attribute associated with a variable in a file. More...
 
integer function spio_put_att::pio_put_att_fh_vid_0d_text (fh, varid, attname, attval)
 Write/Put a string attribute associated with a variable in a file. More...
 
integer function spio_put_att::pio_put_att_fh_vid_1d_text (fh, varid, attname, attval)
 Write/Put a string attribute associated with a variable in a file. More...
 
integer function spio_put_att::pio_put_att_file_vdesc_0d_text (file, vdesc, attname, attval)
 Write/Put a string attribute associated with a variable in a file. More...
 
integer function spio_put_att::pio_put_att_file_vdesc_1d_text (file, vdesc, attname, attval)
 Write/Put a string attribute associated with a variable in a file. More...
 
integer function spio_put_att::pio_put_att_file_vid_0d_int (file, varid, attname, attval)
 Write/Put an attribute associated with a variable in a file. More...
 
integer function spio_put_att::pio_put_att_file_vid_1d_int (file, varid, attname, attval)
 Write/Put an attribute associated with a variable in a file. More...
 
integer function spio_put_att::pio_put_att_file_vid_0d_real (file, varid, attname, attval)
 Write/Put an attribute associated with a variable in a file. More...
 
integer function spio_put_att::pio_put_att_file_vid_1d_real (file, varid, attname, attval)
 Write/Put an attribute associated with a variable in a file. More...
 
integer function spio_put_att::pio_put_att_file_vid_0d_double (file, varid, attname, attval)
 Write/Put an attribute associated with a variable in a file. More...
 
integer function spio_put_att::pio_put_att_file_vid_1d_double (file, varid, attname, attval)
 Write/Put an attribute associated with a variable in a file. More...
 
integer function spio_put_att::pio_put_att_fh_vid_0d_int (fh, varid, attname, attval)
 Write/Put an attribute associated with a variable in a file. More...
 
integer function spio_put_att::pio_put_att_fh_vid_1d_int (fh, varid, attname, attval)
 Write/Put an attribute associated with a variable in a file. More...
 
integer function spio_put_att::pio_put_att_fh_vid_0d_real (fh, varid, attname, attval)
 Write/Put an attribute associated with a variable in a file. More...
 
integer function spio_put_att::pio_put_att_fh_vid_1d_real (fh, varid, attname, attval)
 Write/Put an attribute associated with a variable in a file. More...
 
integer function spio_put_att::pio_put_att_fh_vid_0d_double (fh, varid, attname, attval)
 Write/Put an attribute associated with a variable in a file. More...
 
integer function spio_put_att::pio_put_att_fh_vid_1d_double (fh, varid, attname, attval)
 Write/Put an attribute associated with a variable in a file. More...
 
integer function spio_put_att::pio_put_att_file_vdesc_0d_int (file, vdesc, attname, attval)
 Write/Put an attribute associated with a variable in a file. More...
 
integer function spio_put_att::pio_put_att_file_vdesc_1d_int (file, vdesc, attname, attval)
 Write/Put an attribute associated with a variable in a file. More...
 
integer function spio_put_att::pio_put_att_file_vdesc_0d_real (file, vdesc, attname, attval)
 Write/Put an attribute associated with a variable in a file. More...
 
integer function spio_put_att::pio_put_att_file_vdesc_1d_real (file, vdesc, attname, attval)
 Write/Put an attribute associated with a variable in a file. More...
 
integer function spio_put_att::pio_put_att_file_vdesc_0d_double (file, vdesc, attname, attval)
 Write/Put an attribute associated with a variable in a file. More...
 
integer function spio_put_att::pio_put_att_file_vdesc_1d_double (file, vdesc, attname, attval)
 Write/Put an attribute associated with a variable in a file. More...
 

Detailed Description

Write ("Put") a variable attribute.

This API can be used to write attributes associated with variables to 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). However note that the library may not perform data consistency checks(that data across all the processes are the same) across MPI processes.

This API is a collective call (Although the library might internally choose to make progress on the write from a single or small subset of MPI processes) on the I/O system associated with the file

Function/Subroutine Documentation

◆ pio_put_att_fh_vid_0d_double()

integer function spio_put_att::pio_put_att_fh_vid_0d_double ( integer, intent(in)  fh,
integer, intent(in)  varid,
character(len=*), intent(in)  attname,
real(r8), intent(in)  attval 
)

Write/Put an attribute 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
[in]attvalThe attribute value (a scalar value or an array of values)
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_put_att_fh_vid_0d_int()

integer function spio_put_att::pio_put_att_fh_vid_0d_int ( integer, intent(in)  fh,
integer, intent(in)  varid,
character(len=*), intent(in)  attname,
integer(i4), intent(in)  attval 
)

Write/Put an attribute 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
[in]attvalThe attribute value (a scalar value or an array of values)
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_put_att_fh_vid_0d_real()

integer function spio_put_att::pio_put_att_fh_vid_0d_real ( integer, intent(in)  fh,
integer, intent(in)  varid,
character(len=*), intent(in)  attname,
real(r4), intent(in)  attval 
)

Write/Put an attribute 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
[in]attvalThe attribute value (a scalar value or an array of values)
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_put_att_fh_vid_0d_text()

integer function spio_put_att::pio_put_att_fh_vid_0d_text ( integer, intent(in)  fh,
integer, intent(in)  varid,
character(len=*), intent(in)  attname,
character(len=*), intent(in)  attval 
)

Write/Put a string attribute 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
[in]attvalThe attribute value (string or an array of strings)
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_put_att_fh_vid_1d_double()

integer function spio_put_att::pio_put_att_fh_vid_1d_double ( integer, intent(in)  fh,
integer, intent(in)  varid,
character(len=*), intent(in)  attname,
real(r8), dimension(:), intent(in)  attval 
)

Write/Put an attribute 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
[in]attvalThe attribute value (a scalar value or an array of values)
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_put_att_fh_vid_1d_int()

integer function spio_put_att::pio_put_att_fh_vid_1d_int ( integer, intent(in)  fh,
integer, intent(in)  varid,
character(len=*), intent(in)  attname,
integer(i4), dimension(:), intent(in)  attval 
)

Write/Put an attribute 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
[in]attvalThe attribute value (a scalar value or an array of values)
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_put_att_fh_vid_1d_real()

integer function spio_put_att::pio_put_att_fh_vid_1d_real ( integer, intent(in)  fh,
integer, intent(in)  varid,
character(len=*), intent(in)  attname,
real(r4), dimension(:), intent(in)  attval 
)

Write/Put an attribute 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
[in]attvalThe attribute value (a scalar value or an array of values)
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_put_att_fh_vid_1d_text()

integer function spio_put_att::pio_put_att_fh_vid_1d_text ( integer, intent(in)  fh,
integer, intent(in)  varid,
character(len=*), intent(in)  attname,
character(len=*), dimension(:), intent(in)  attval 
)

Write/Put a string attribute 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
[in]attvalThe attribute value (string or an array of strings)
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_put_att_file_vdesc_0d_double()

integer function spio_put_att::pio_put_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(in)  attval 
)

Write/Put an 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]vdescThe handle to the variable. Variable description structure.
[in]attnameThe name of the attribute
[in]attvalThe attribute value (a scalar value or an array of values)
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_put_att_file_vdesc_0d_int()

integer function spio_put_att::pio_put_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(in)  attval 
)

Write/Put an 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]vdescThe handle to the variable. Variable description structure.
[in]attnameThe name of the attribute
[in]attvalThe attribute value (a scalar value or an array of values)
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_put_att_file_vdesc_0d_real()

integer function spio_put_att::pio_put_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(in)  attval 
)

Write/Put an 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]vdescThe handle to the variable. Variable description structure.
[in]attnameThe name of the attribute
[in]attvalThe attribute value (a scalar value or an array of values)
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_put_att_file_vdesc_0d_text()

integer function spio_put_att::pio_put_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(in)  attval 
)

Write/Put 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]vdescThe handle to the variable. Variable description structure.
[in]attnameThe name of the attribute
[in]attvalThe attribute value (string or an array of strings)
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_put_att_file_vdesc_1d_double()

integer function spio_put_att::pio_put_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(in)  attval 
)

Write/Put an 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]vdescThe handle to the variable. Variable description structure.
[in]attnameThe name of the attribute
[in]attvalThe attribute value (a scalar value or an array of values)
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_put_att_file_vdesc_1d_int()

integer function spio_put_att::pio_put_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(in)  attval 
)

Write/Put an 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]vdescThe handle to the variable. Variable description structure.
[in]attnameThe name of the attribute
[in]attvalThe attribute value (a scalar value or an array of values)
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_put_att_file_vdesc_1d_real()

integer function spio_put_att::pio_put_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(in)  attval 
)

Write/Put an 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]vdescThe handle to the variable. Variable description structure.
[in]attnameThe name of the attribute
[in]attvalThe attribute value (a scalar value or an array of values)
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_put_att_file_vdesc_1d_text()

integer function spio_put_att::pio_put_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(in)  attval 
)

Write/Put 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]vdescThe handle to the variable. Variable description structure.
[in]attnameThe name of the attribute
[in]attvalThe attribute value (string or an array of strings)
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_put_att_file_vid_0d_double()

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

Write/Put an 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
[in]attvalThe attribute value (a scalar value or an array of values)
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_put_att_file_vid_0d_int()

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

Write/Put an 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
[in]attvalThe attribute value (a scalar value or an array of values)
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_put_att_file_vid_0d_real()

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

Write/Put an 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
[in]attvalThe attribute value (a scalar value or an array of values)
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_put_att_file_vid_0d_text()

integer function spio_put_att::pio_put_att_file_vid_0d_text ( type(file_desc_t), intent(in)  file,
integer, intent(in)  varid,
character(len=*), intent(in)  attname,
character(len=*), intent(in)  attval 
)

Write/Put 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
[in]attvalThe attribute value (string or an array of strings)
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_put_att_file_vid_1d_double()

integer function spio_put_att::pio_put_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(in), target  attval 
)

Write/Put an 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
[in]attvalThe attribute value (a scalar value or an array of values)
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_put_att_file_vid_1d_int()

integer function spio_put_att::pio_put_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(in), target  attval 
)

Write/Put an 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
[in]attvalThe attribute value (a scalar value or an array of values)
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_put_att_file_vid_1d_real()

integer function spio_put_att::pio_put_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(in), target  attval 
)

Write/Put an 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
[in]attvalThe attribute value (a scalar value or an array of values)
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_put_att_file_vid_1d_text()

integer function spio_put_att::pio_put_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(in)  attval 
)

Write/Put 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
[in]attvalThe attribute value (string or an array of strings)
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)