From 8369a1a908febdd4e89bb6773248fd209e631886 Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Thu, 26 Jun 2003 11:52:42 -0500 Subject: [svn-r7112] Purpose: Primarily edits from technical review Description: H5Dread H5Dwrite Clarify library behavior with certain mem_space_id/file_space_id combinations. Add comment regarding when space is allocated and fill values written. H5Dget_space_status -- Correct return value. Copy edits and formatting fixes. Platforms tested: IE 5, Safari --- doc/html/RM_H5D.html | 55 ++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 40 insertions(+), 15 deletions(-) diff --git a/doc/html/RM_H5D.html b/doc/html/RM_H5D.html index c45e353..7b4356d 100644 --- a/doc/html/RM_H5D.html +++ b/doc/html/RM_H5D.html @@ -345,7 +345,7 @@ facilitate moving easily between them.
Name: H5Dget_space_status
Signature: -
hid_t H5Dget_space_status(hid_t dset_id, +
herr_t H5Dget_space_status(hid_t dset_id, H5D_space_status_t *status)
Purpose:
Determines whether space has been allocated for a dataset. @@ -378,7 +378,7 @@ facilitate moving easily between them.
hid_t dset_id
IN: Identifier of the dataset to query.
H5D_space_status_t *status -
OUT: Space allocatioin status. +
OUT: Space allocation status.
Returns:
Returns a non-negative value if successful; @@ -704,7 +704,7 @@ facilitate moving easily between them. - H5S_ALL + H5S_ALL valid dataspace identifier @@ -713,8 +713,8 @@ facilitate moving easily between them. The file dataset's dataspace is used for the memory dataspace and the selection specified with file_space_id specifies the selection within it. - file_space_id specifies the selection within the file - dataset's dataspace. + The combination of the file dataset's dataspace and the selection from + file_space_id is used for memory also. @@ -723,7 +723,7 @@ facilitate moving easily between them. valid dataspace identifier - H5S_ALL + H5S_ALL mem_space_id specifies the memory dataspace and the @@ -735,10 +735,10 @@ facilitate moving easily between them. - H5S_ALL + H5S_ALL - H5S_ALL + H5S_ALL The file dataset's dataspace is used for the memory dataspace and the @@ -751,7 +751,7 @@ facilitate moving easily between them.

- Setting an "all" selection indicates that the entire dataspace, as + Setting an H5S_ALL selection indicates that the entire dataspace, as defined by the current dimensions of a dataspace, will be selected. The number of elements selected in the memory dataspace must match the number of elements selected in the file dataspace. @@ -761,7 +761,7 @@ facilitate moving easily between them.

Data is automatically converted from the file datatype and dataspace to the memory datatype and dataspace - at the time of the write. See the + at the time of the read. See the Data Conversion section of The Data Type Interface (H5T) in the HDF5 User's Guide for a discussion of @@ -879,8 +879,8 @@ facilitate moving easily between them. The file dataset's dataspace is used for the memory dataspace and the selection specified with file_space_id specifies the selection within it. - file_space_id specifies the selection within the file - dataset's dataspace. + The combination of the file dataset's dataspace and the selection from + file_space_id is used for memory also. @@ -913,7 +913,6 @@ facilitate moving easily between them. selection. -

@@ -936,6 +935,20 @@ facilitate moving easily between them. HDF5 User's Guide for a discussion of data conversion, including the range of conversions currently supported by the HDF5 libraries. +

+ If the dataset's space allocation time is set to + H5D_ALLOC_TIME_LATE or H5D_ALLOC_TIME_INCR + and the space for the dataset has not yet been allocated, + that space is allocated when the first raw data is written to the + dataset. + Unused space in the dataset will be written with fill values at the + same time if the dataset's fill time is set to + H5D_FILL_TIME_IFSET or H5D_FILL_TIME_ALLOC. + (Also see + H5Pset_fill_time + and + H5Pset_alloc_time.) +

Parameters:
hid_t dataset_id @@ -979,6 +992,18 @@ facilitate moving easily between them. The dimensionality of size is the same as that of the dataspace of the dataset being changed. This function cannot be applied to a dataset with fixed dimensions. +

+ Space on disk is immediately allocated for the new dataset extent + if the dataset's space allocation time is set to + H5D_ALLOC_TIME_EARLY. + Fill values will be written to the dataset if the dataset's fill time + is set to H5D_FILL_TIME_IFSET or + H5D_FILL_TIME_ALLOC. + (Also see + H5Pset_fill_time + and + H5Pset_alloc_time.) +

Parameters:
hid_t dataset_id @@ -1120,7 +1145,7 @@ facilitate moving easily between them. before filling the selection.
Note:
Applications sometimes write data only to portions of - an allcoated dataset. It is often useful in such cases + an allocated dataset. It is often useful in such cases to fill the unused space with a known fill value. See H5Pset_fill_value @@ -1200,7 +1225,7 @@ And in this document, the Describes HDF5 Release 1.5, Unreleased Development Branch -Last modified: 10 June 2003 +Last modified: 25 June 2003 -- cgit v0.12