MAPL_FileMetadataUtilsMod Module


Uses

  • module~~mapl_filemetadatautilsmod~~UsesGraph module~mapl_filemetadatautilsmod MAPL_FileMetadataUtilsMod ESMF ESMF module~mapl_filemetadatautilsmod->ESMF iso_fortran_env iso_fortran_env module~mapl_filemetadatautilsmod->iso_fortran_env module~mapl_abstractgridfactorymod MAPL_AbstractGridFactoryMod module~mapl_filemetadatautilsmod->module~mapl_abstractgridfactorymod module~mapl_exceptionhandling MAPL_ExceptionHandling module~mapl_filemetadatautilsmod->module~mapl_exceptionhandling module~mapl_gridmanagermod MAPL_GridManagerMod module~mapl_filemetadatautilsmod->module~mapl_gridmanagermod module~pfio pFIO module~mapl_filemetadatautilsmod->module~pfio

Used by

  • module~~mapl_filemetadatautilsmod~~UsedByGraph module~mapl_filemetadatautilsmod MAPL_FileMetadataUtilsMod module~bundletestsupport BundleTestSupport module~bundletestsupport->module~mapl_filemetadatautilsmod module~historytrajectory_implement HistoryTrajectory_implement module~historytrajectory_implement->module~mapl_filemetadatautilsmod module~historytrajectorymod HistoryTrajectoryMod module~historytrajectorymod->module~mapl_filemetadatautilsmod module~mapl_datacollectionmod MAPL_DataCollectionMod module~mapl_datacollectionmod->module~mapl_filemetadatautilsmod module~mapl_epochswathmod MAPL_EpochSwathMod module~mapl_epochswathmod->module~mapl_filemetadatautilsmod module~mapl_esmffieldbundleread MAPL_ESMFFieldBundleRead module~mapl_esmffieldbundleread->module~mapl_filemetadatautilsmod module~mapl_extdataabstractfilehandler MAPL_ExtdataAbstractFileHandler module~mapl_extdataabstractfilehandler->module~mapl_filemetadatautilsmod module~mapl_extdataclimfilehandler MAPL_ExtdataClimFileHandler module~mapl_extdataclimfilehandler->module~mapl_filemetadatautilsmod module~mapl_extdatafilestream MAPL_ExtDataFileStream module~mapl_extdatafilestream->module~mapl_filemetadatautilsmod module~mapl_extdatagridcomp2g MAPL_ExtDataGridComp2G module~mapl_extdatagridcomp2g->module~mapl_filemetadatautilsmod module~mapl_extdatagridcompmod MAPL_ExtDataGridCompMod module~mapl_extdatagridcompmod->module~mapl_filemetadatautilsmod module~mapl_extdatasimplefilehandler MAPL_ExtdataSimpleFileHandler module~mapl_extdatasimplefilehandler->module~mapl_filemetadatautilsmod module~mapl_extdatatypedef MAPL_ExtDataTypeDef module~mapl_extdatatypedef->module~mapl_filemetadatautilsmod module~mapl_filemetadatautilsvectormod MAPL_FileMetadataUtilsVectorMod module~mapl_filemetadatautilsvectormod->module~mapl_filemetadatautilsmod module~mapl_griddediomod MAPL_GriddedIOMod module~mapl_griddediomod->module~mapl_filemetadatautilsmod module~maplbase_mod MAPLBase_Mod module~maplbase_mod->module~mapl_filemetadatautilsmod module~masksamplermod MaskSamplerMod module~masksamplermod->module~mapl_filemetadatautilsmod module~verticalcoordinatemod VerticalCoordinateMod module~verticalcoordinatemod->module~mapl_filemetadatautilsmod program~regrid_util Regrid_Util program~regrid_util->module~mapl_filemetadatautilsmod program~time_ave time_ave program~time_ave->module~mapl_filemetadatautilsmod

Interfaces

public interface FileMetadataUtils


Derived Types

type, public, extends(FileMetadata) ::  FileMetadataUtils

Constructor

public function new_FilemetadataUtils (metadata, fName)

Type-Bound Procedures

generic, public :: add_attribute => add_attribute_0d, add_attribute_1d
procedure, public :: add_attribute_0d
procedure, public :: add_attribute_1d
procedure, public :: add_dimension
procedure, public :: add_variable
procedure, public :: create
procedure, public :: equal
procedure, public :: get_attribute
procedure, public :: get_attributes
procedure, public :: get_coordinate_info
procedure, public :: get_coordinate_variable
procedure, public :: get_dimension
procedure, public :: get_dimensions
procedure, public :: get_file_name
procedure, public :: get_global_var
procedure, public :: get_level_name
procedure, public :: get_order
procedure, public :: get_source_file
procedure, public :: get_time_info
procedure, public :: get_var_attr_int32
procedure, public :: get_var_attr_int64
procedure, public :: get_var_attr_real32
procedure, public :: get_var_attr_real64
procedure, public :: get_var_attr_string
procedure, public :: get_variable
procedure, public :: get_variable_attribute
procedure, public :: get_variables
procedure, public :: has_attribute
procedure, public :: has_dimension
procedure, public :: has_variable
procedure, public :: is_coordinate_variable
procedure, public :: is_var_present
procedure, public :: merge
procedure, public :: modify_dimension
procedure, public :: modify_variable
procedure, public :: not_equal
generic, public :: operator(/=) => not_equal
generic, public :: operator(==) => equal
procedure, public :: remove_attribute
procedure, public :: remove_variable
procedure, public :: serialize
procedure, public :: set_order
procedure, public :: set_source_file
procedure, public :: var_get_missing_value
procedure, public :: var_has_attr
procedure, public :: var_has_missing_value
generic, public :: write(formatted) => write_formatted
procedure, public :: write_formatted

Functions

public function get_file_name(this, rc) result(fname)

Arguments

Type IntentOptional Attributes Name
class(FileMetadataUtils), intent(inout) :: this
integer, intent(out), optional :: rc

Return Value character(len=:), allocatable

public function get_level_name(this, rc) result(lev_name)

Arguments

Type IntentOptional Attributes Name
class(FileMetadataUtils), intent(inout), target :: this
integer, intent(out), optional :: rc

Return Value character(len=:), allocatable

public function get_var_attr_string(this, var_name, attr_name, rc) result(attr_string)

Arguments

Type IntentOptional Attributes Name
class(FileMetadataUtils), intent(inout) :: this
character(len=*), intent(in) :: var_name
character(len=*), intent(in) :: attr_name
integer, intent(out), optional :: rc

Return Value character(len=:), allocatable

public function get_variable_attribute(this, var_name, attr_name, rc) result(units)

Arguments

Type IntentOptional Attributes Name
class(FileMetadataUtils), intent(inout) :: this
character(len=*), intent(in) :: var_name
character(len=*), intent(in) :: attr_name
integer, intent(out), optional :: rc

Return Value character(len=:), pointer

public function get_var_attr_int32(this, var_name, attr_name, rc) result(attr_int32)

Arguments

Type IntentOptional Attributes Name
class(FileMetadataUtils), intent(inout) :: this
character(len=*), intent(in) :: var_name
character(len=*), intent(in) :: attr_name
integer, intent(out), optional :: rc

Return Value integer(kind=INT32)

public function get_var_attr_int64(this, var_name, attr_name, rc) result(attr_int64)

Arguments

Type IntentOptional Attributes Name
class(FileMetadataUtils), intent(inout) :: this
character(len=*), intent(in) :: var_name
character(len=*), intent(in) :: attr_name
integer, intent(out), optional :: rc

Return Value integer(kind=INT64)

public function is_var_present(this, var_name, rc) result(isPresent)

Arguments

Type IntentOptional Attributes Name
class(FileMetadataUtils), intent(inout) :: this
character(len=*), intent(in) :: var_name
integer, intent(out), optional :: rc

Return Value logical

public function var_has_attr(this, var_name, attr_name, rc)

Arguments

Type IntentOptional Attributes Name
class(FileMetadataUtils), intent(inout) :: this
character(len=*), intent(in) :: var_name
character(len=*), intent(in) :: attr_name
integer, intent(out), optional :: rc

Return Value logical

public function var_has_missing_value(this, var_name, rc)

Arguments

Type IntentOptional Attributes Name
class(FileMetadataUtils), intent(inout) :: this
character(len=*), intent(in) :: var_name
integer, intent(out), optional :: rc

Return Value logical

public function get_var_attr_real32(this, var_name, attr_name, rc) result(attr_real32)

Arguments

Type IntentOptional Attributes Name
class(FileMetadataUtils), intent(inout) :: this
character(len=*), intent(in) :: var_name
character(len=*), intent(in) :: attr_name
integer, intent(out), optional :: rc

Return Value real(kind=REAL32)

public function var_get_missing_value(this, var_name, rc) result(missing_value)

Arguments

Type IntentOptional Attributes Name
class(FileMetadataUtils), intent(inout) :: this
character(len=*), intent(in) :: var_name
integer, intent(out), optional :: rc

Return Value real(kind=REAL32)

public function get_var_attr_real64(this, var_name, attr_name, rc) result(attr_real64)

Arguments

Type IntentOptional Attributes Name
class(FileMetadataUtils), intent(inout) :: this
character(len=*), intent(in) :: var_name
character(len=*), intent(in) :: attr_name
integer, intent(out), optional :: rc

Return Value real(kind=REAL64)

public function new_FilemetadataUtils(metadata, fName) result(metadata_utils)

Arguments

Type IntentOptional Attributes Name
type(FileMetadata), intent(in) :: metadata
character(len=*), intent(in) :: fName

Return Value type(FileMetadataUtils)


Subroutines

public subroutine create(this, metadata, fName)

Arguments

Type IntentOptional Attributes Name
class(FileMetadataUtils), intent(inout) :: this
type(FileMetadata), intent(in) :: metadata
character(len=*), intent(in) :: fName

public subroutine get_coordinate_info(this, coordinate_name, coordSize, coordUnits, long_name, standard_name, coords, coordinate_attr, rc)

Arguments

Type IntentOptional Attributes Name
class(FileMetadataUtils), intent(inout) :: this
character(len=*), intent(in) :: coordinate_name
integer, intent(out), optional :: coordSize
character(len=*), intent(out), optional :: coordUnits
character(len=*), intent(out), optional :: long_name
character(len=*), intent(out), optional :: standard_name
real, intent(inout), optional, allocatable :: coords(:)
character(len=*), intent(out), optional :: coordinate_attr
integer, intent(out), optional :: rc

public subroutine get_time_info(this, startTime, startYear, startMonth, startDay, startHour, startMin, startSec, units, timeVector, rc)

Arguments

Type IntentOptional Attributes Name
class(FileMetadataUtils), intent(inout) :: this
type(ESMF_Time), intent(inout), optional :: startTime
integer, intent(out), optional :: startYear
integer, intent(out), optional :: startMonth
integer, intent(out), optional :: startDay
integer, intent(out), optional :: startHour
integer, intent(out), optional :: startMin
integer, intent(out), optional :: startSec
character(len=*), intent(out), optional :: units
type(ESMF_Time), optional, allocatable :: timeVector(:)
integer, intent(out), optional :: rc