dm_hdf5_read Interface

public interface dm_hdf5_read

Generic HDF5 read function.


Module Procedures

private function hdf5_read_nodes(id, nodes, data_set) result(rc)

Reads array of node_type from compound data in HDF5 file. If data_set is not passed, the name will be set to the value of HDF5_DATASET_NODE.

The function returns the following error codes:

  • E_INVALID if the passed id is invalid.
  • E_ALLOC if allocation of array nodes failed.
  • E_HDF5 if the HDF5 library call failed.

Arguments

Type IntentOptional Attributes Name
class(hdf5_id_type), intent(inout) :: id

HDF5 file or group type.
type(node_type), intent(out), allocatable, target :: nodes(:)

Node type array.
character(len=*), intent(in), optional :: data_set

Name of data set.

Return Value integer

private function hdf5_read_observs(id, observs, data_set) result(rc)

Reads array of observ_type from compound data in HDF5 file. If data_set is not passed, the name will be set to the value of HDF5_DATASET_OBSERV.

The function returns the following error codes:

  • E_INVALID if the passed id is invalid.
  • E_ALLOC if allocation of array observs failed.
  • E_HDF5 if the HDF5 library call failed.

Arguments

Type IntentOptional Attributes Name
class(hdf5_id_type), intent(inout) :: id

HDF5 file or group type.
type(observ_type), intent(out), allocatable, target :: observs(:)

Observation type array.
character(len=*), intent(in), optional :: data_set

Name of data set.

Return Value integer

private function hdf5_read_sensors(id, sensors, data_set) result(rc)

Reads array of sensor_type from compound data in HDF5 file. If data_set is not passed, the name will be set to the value of HDF5_DATASET_SENSOR.

The function returns the following error codes:

  • E_INVALID if the passed id is invalid.
  • E_ALLOC if allocation of array sensors failed.
  • E_HDF5 if the HDF5 library call failed.

Arguments

Type IntentOptional Attributes Name
class(hdf5_id_type), intent(inout) :: id

HDF5 file or group type.
type(sensor_type), intent(out), allocatable, target :: sensors(:)

Sensor type array.
character(len=*), intent(in), optional :: data_set

Name of data set.

Return Value integer

private function hdf5_read_targets(id, targets, data_set) result(rc)

Reads array of target_type from compound data in HDF5 file. If data_set is not passed, the name will be set to the value of HDF5_DATASET_TARGET.

The function returns the following error codes:

  • E_INVALID if the passed id is invalid.
  • E_ALLOC if allocation of array targets failed.
  • E_HDF5 if the HDF5 library call failed.

Arguments

Type IntentOptional Attributes Name
class(hdf5_id_type), intent(inout) :: id

HDF5 file or group type.
type(target_type), intent(out), allocatable, target :: targets(:)

Target type array.
character(len=*), intent(in), optional :: data_set

Name of data set.

Return Value integer