HDF5 1.14.5
API Reference
|
Modules | |
module | h5ds |
This module contains Fortran interfaces for H5DS. | |
Functions/Subroutines | |
subroutine | h5dsset_scale_f (dsid, errcode, dimname) |
Convert dataset dsid to a dimension scale, with optional name, dimname . | |
subroutine | h5dsattach_scale_f (did, dsid, idx, errcode) |
Attach dimension scale dsid to dimension idx of dataset did . | |
subroutine | h5dsdetach_scale_f (did, dsid, idx, errcode) |
Detach dimension scale dsid from the dimension idx of dataset did . | |
subroutine | h5dsis_attached_f (did, dsid, idx, is_attached, errcode) |
Report if dimension scale dsid is currently attached to dimension idx of dataset did. | |
subroutine | h5dsis_scale_f (did, is_scale, errcode) |
Determines whether did is a Dimension Scale. | |
subroutine | h5dsset_label_f (did, idx, label, errcode) |
Set label for the dimension idx of did to the value label . | |
subroutine | h5dsget_label_f (did, idx, label, size, errcode) |
Read the label for dimension idx of did into buffer label . | |
subroutine | h5dsget_scale_name_f (did, name, size, errcode) |
Read the name of scale did into buffer name. | |
subroutine | h5dsget_num_scales_f (did, idx, num_scales, errcode) |
Determines how many Dimension Scales are attached to dimension idx of did . | |
subroutine h5dsattach_scale_f | ( | integer(hid_t), intent(in) | did, |
integer(hid_t), intent(in) | dsid, | ||
integer, intent(in) | idx, | ||
integer | errcode | ||
) |
Attach dimension scale dsid to dimension idx
of dataset did
.
did | The dataset. |
dsid | The scale to be attached. |
idx | The dimension of did that dsid is associated with. |
errcode | Returns 0 if successful and -1 if it fails. |
See C API: H5DSattach_scale()
subroutine h5dsdetach_scale_f | ( | integer(hid_t), intent(in) | did, |
integer(hid_t), intent(in) | dsid, | ||
integer, intent(in) | idx, | ||
integer | errcode | ||
) |
Detach dimension scale dsid from the dimension idx of dataset did
.
did | The dataset. |
dsid | The scale to be detached. |
idx | The dimension of did to detach. |
errcode | Returns 0 if successful and -1 if it fails. |
subroutine h5dsget_label_f | ( | integer(hid_t), intent(in) | did, |
integer, intent(in) | idx, | ||
character(len=*), intent(inout) | label, | ||
integer(size_t), intent(inout) | size, | ||
integer | errcode | ||
) |
Read the label
for dimension idx
of did
into buffer label
.
did | The dataset. |
idx | The dimension. |
label | The label. |
size | The length of the label buffer. |
errcode | Returns 0 if successful and -1 if it fails. |
See C API: H5DSget_label()
subroutine h5dsget_num_scales_f | ( | integer(hid_t), intent(in) | did, |
integer, intent(in) | idx, | ||
integer, intent(inout) | num_scales, | ||
integer | errcode | ||
) |
Determines how many Dimension Scales are attached to dimension idx of did
.
did | The dataset to query. |
idx | The dimension of did to query. |
num_scales | Number of Dimension Scales associated with did . |
errcode | Returns 0 if successful and -1 if it fails. |
See C API: H5DSget_num_scales()
subroutine h5dsget_scale_name_f | ( | integer(hid_t), intent(in) | did, |
character(len=*), intent(inout) | name, | ||
integer(size_t), intent(inout) | size, | ||
integer | errcode | ||
) |
Read the name of scale did
into buffer name.
did | Dimension scale identifier. |
name | Buffer to contain the returned name. |
size | Size in bytes, of the name buffer. |
errcode | Returns 0 if successful and -1 if it fails. |
See C API: H5DSget_scale_name()
subroutine h5dsis_attached_f | ( | integer(hid_t), intent(in) | did, |
integer(hid_t), intent(in) | dsid, | ||
integer, intent(in) | idx, | ||
logical, intent(out) | is_attached, | ||
integer | errcode | ||
) |
Report if dimension scale dsid is currently attached to dimension idx of dataset did.
did | The dataset. |
dsid | The scale to be attached. |
idx | The dimension of did that dsid is associated with. |
is_attached | If dimension scale dsid is currently attached to dimension idx of dataset did . |
errcode | Returns 0 if successful and -1 if it fails. |
See C API: H5DSis_attached()
subroutine h5dsis_scale_f | ( | integer(hid_t), intent(in) | did, |
logical, intent(out) | is_scale, | ||
integer, intent(out) | errcode | ||
) |
Determines whether did
is a Dimension Scale.
did | The data set to query. |
is_scale | If is a Dimension Scale. |
errcode | Returns 0 if successful and -1 if it fails. |
See C API: H5DSis_scale()
subroutine h5dsset_label_f | ( | integer(hid_t), intent(in) | did, |
integer, intent(in) | idx, | ||
character(len=*), intent(in) | label, | ||
integer | errcode | ||
) |
Set label for the dimension idx
of did
to the value label
.
did | The data set. |
idx | The dimension. |
label | The label. |
errcode | Returns 0 if successful and -1 if it fails. |
See C API: H5DSset_label()
subroutine h5dsset_scale_f | ( | integer(hid_t), intent(in) | dsid, |
integer | errcode, | ||
character(len=*), intent(in), optional | dimname | ||
) |
Convert dataset dsid
to a dimension scale, with optional name, dimname
.
dsid | The dataset to be made a Dimemsion Scale. |
errcode | Returns 0 if successful and -1 if it fails. |
dimname | The dimension name |
See C API: H5DSset_scale()