pio_inquire_variable Interface

public interface pio_inquire_variable

\defgroup PIO_inquire_variable


Module Procedures

private function inquire_variable_vid(ncid, varid, name, xtype, ndims, dimids, natts) result(ierr)

@public @ingroup PIO_inquire_variable @brief Inquires if a NetCDF variable is present and returns its attributes @details @param ncid : A netcdf file descriptor returned by \ref PIO_openfile or \ref PIO_createfile. @param varid : The netcdf variable ID. @param name : The name of the variable @param xtype : The type of the variable @param ndims : The number of dimensions for the variable. @param dimids : The dimension identifier returned by \ref PIO_def_dim @param natts : Number of attributes associated with the variable @retval ierr @copydoc error_return

Arguments

Type IntentOptional Attributes Name
type(File_desc_t), intent(in) :: ncid
integer, intent(in) :: varid
character(len=*), intent(out), optional :: name
integer, intent(out), optional :: xtype
integer, intent(out), optional :: ndims
integer, intent(out), optional, dimension(:) :: dimids
integer, intent(out), optional :: natts

Return Value integer

private function inquire_variable_vdesc(ncid, vardesc, name, xtype, ndims, dimids, natts) result(ierr)

@public @ingroup PIO_inquire_variable @brief Inquires if a NetCDF variable is present and returns its attributes @details @param ncid : A netcdf file descriptor returned by \ref PIO_openfile or \ref PIO_createfile. @param vardesc @copydoc var_desc_t @param name : The name of the variable @param xtype : The type of the variable @param ndims : The number of dimensions for the variable. @param dimids : The dimension identifier returned by \ref PIO_def_dim @param natts : Number of attributes associated with the variable @retval ierr @copydoc error_return

Arguments

Type IntentOptional Attributes Name
type(File_desc_t), intent(in) :: ncid
type(Var_desc_t), intent(in) :: vardesc
character(len=*), intent(out), optional :: name
integer, intent(out), optional :: xtype
integer, intent(out), optional :: ndims
integer, intent(out), optional, dimension(:) :: dimids
integer, intent(out), optional :: natts

Return Value integer