dm_hdf5_write Interface

public interface dm_hdf5_write

Generic HDF5 write function.


Module Procedures

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

Creates HDF5 data space and writes nodes to HDF5 file or group. 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 given HDF5 id type (file, group) is invalid.
  • E_EMPTY if the passed node array is of size 0.
  • 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(inout), target :: nodes(:)

Node type array.

character(len=*), intent(in), optional :: data_set

Name of data set.

Return Value integer

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

Creates HDF5 data space and writes observations to HDF5 file or group. 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 given HDF5 id type (file, group) is invalid.
  • E_EMPTY if the passed observation array is of size 0.
  • 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(inout), target :: observs(:)

Observation type array.

character(len=*), intent(in), optional :: data_set

Name of data set.

Return Value integer

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

Creates HDF5 data space and writes targets to HDF5 file or group. 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 given HDF5 id type (file, group) is invalid.
  • E_EMPTY if the passed target array is of size 0.
  • 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(inout), target :: targets(:)

Target type array.

character(len=*), intent(in), optional :: data_set

Name of data set.

Return Value integer

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

Creates HDF5 data space and writes sensors to HDF5 file or group. 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 given HDF5 id type (file, group) is invalid.
  • E_EMPTY if the passed sensor array is of size 0.
  • 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(inout), target :: sensors(:)

Sensor type array.

character(len=*), intent(in), optional :: data_set

Name of data set.

Return Value integer