From 715460cf620cfbb488622274a6c92920ab0c58a8 Mon Sep 17 00:00:00 2001 From: Quincey Koziol Date: Sat, 14 Feb 2004 09:39:18 -0500 Subject: [svn-r8203] Purpose: Doc cleanup Description: Correct several grammar problems, as well as clarify a few more things, based on John's feedback. --- doc/html/H5.format.html | 54 +++++++++++++++++++++++++++++++++++-------------- 1 file changed, 39 insertions(+), 15 deletions(-) diff --git a/doc/html/H5.format.html b/doc/html/H5.format.html index e7fc29b..3f08972 100644 --- a/doc/html/H5.format.html +++ b/doc/html/H5.format.html @@ -2034,8 +2034,8 @@ TABLE.list TD { border:none; } Disk Format: Level 2A - Data Object Headers

The header information of an object is designed to encompass - all the information about an object which would be desired to be - known, except for the data itself. This information includes + all the information about an object, except for the data itself. + This information includes the dataspace, datatype, information about how the data is stored on disk (in external files, compressed, broken up in blocks, etc.), as well as other information used by the library @@ -2207,8 +2207,8 @@ TABLE.list TD { border:none; } 1 - If set, the message is stored in the global heap and - the Header Message Data field contains a Shared Object + If set, the message is stored in the global heap. + The Header Message Data field contains a Shared Object message and the Size of Header Message Data field contains the size of that Shared Object message. @@ -3509,8 +3509,13 @@ TABLE.list TD { border:none; } member definitions of the compound datatype. The member definitions appear one after another with no intervening bytes. The member types are described with a recursive datatype - message. Note that the property descriptions are different for different - versions of the datatype version. + message. + +

Note that the property descriptions are different for different + versions of the datatype version. Additionally note that the version + 0 properties are deprecated and have been replaced with the version + 1 properties in versions of the HDF5 library from the 1.4 release + onward.

@@ -3749,7 +3754,7 @@ TABLE.list TD { border:none; } 2 Internal Reference: A reference to a region within the - current dataset. + current dataset. (Not currently implemented) @@ -4063,6 +4068,14 @@ TABLE.list TD { border:none; }

There are no bit fields defined for the array class.

+

Note that the dimension information defined in the property for this + datatype class is independent of dataspace information for a dataset. + The dimension information here describes the dimensionality of the + information within a data element (or a component of an element, if the + array datatype is nested within another datatype) and the dataspace for a + dataset describes the location of the elements in a dataset. +

+
@@ -4773,16 +4786,22 @@ TABLE.list TD { border:none; } Header Message Type: 0x0009
Length: N/A
Status: N/A
- Purpose and Description: N/A
- Format of Data: N/A + Format of Data: N/A
+ +

Purpose and Description: This message type was skipped during + the initial specification of the file format and may be used in a + future expansion to the format.

Name: Reserved - Not Assigned Yet

Header Message Type: 0x000A
Length: N/A
Status: N/A
- Purpose and Description: N/A
- Format of Data: N/A + Format of Data: N/A
+ +

Purpose and Description: This message type was skipped during + the initial specification of the file format and may be used in a + future expansion to the format.

Name: Data Storage - Filter Pipeline

@@ -4977,10 +4996,15 @@ TABLE.list TD { border:none; } as attributes, or "metadata" about the current object. An attribute is a small dataset; it has a name, a datatype, a data space, and raw data. Since attributes are stored in the object - header they must be relatively small (<64kb) and can be + header they must be relatively small (<64KB) and can be associated with any type of object which has an object header (groups, datasets, named types and spaces, etc.). +

Note: Attributes on an object must have unique names. (The HDF5 library + currently enforces this by causing the creation of an attribute with + a duplicate name to fail) + Attributes on different objects may have the same name, however. +

@@ -5493,14 +5517,14 @@ in a different machine format with the architecture-type information from the number-type header message. This means that each architecture will need to [potentially] byte-swap data values into the internal representation for that particular machine. -

Data with a "variable" sized number-type is stored in a data heap -internal to the HDF5 file. Global heap identifiers are stored in the +

Data with a variable-length datatype is stored in the global heap +of the HDF5 file. Global heap identifiers are stored in the data object storage.

Data whose elements are composed of pointer number-types are stored in several different ways depending on the particular pointer type involved. Simple pointers are just stored as the dataset offset of the object being pointed to with the size of the pointer being the same number of bytes as offsets in the file. -Partial-object pointers are stored as a heap-ID which points to the following +Dataset region references are stored as a heap-ID which points to the following information within the file-heap: an offset of the object pointed to, number-type information (same format as header message), dimensionality information (same format as header message), sub-set start and end information (i.e. a coordinate -- cgit v0.12