From d216d71c168a46087c2334f07fadfa779ef288dc Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Wed, 8 Mar 2000 17:20:27 -0500 Subject: [svn-r2007] Datasets.html Groups.html Added note that object names (in Groups.html) or dataset names (in Datasets.html) must be unique. Changed 'boot block' to 'super block'. (Groups.html only) Files.html Minor formatting fixes. Datatypes.html H5Tconvert: Added plist_id parameter. References.html Deleted "not implemented" and related messages. Added description of H5Rget_object_type. Deleted all material about internal dataset region references. [Unlikely to be implemented (QK) and there was very little info.] Commented out references to H5R_BADTYPE. [This appeared in the list of "valid types", which it is not. And user is instructed to test for 'a negative value' rather than 'H5R_BADTYPE'. So this was deemed not to be user-level information.] Changed 'boot block' to 'super block'. Other minor editing changes. --- doc/html/Datasets.html | 12 +++++++---- doc/html/Groups.html | 7 ++++++- doc/html/References.html | 54 +++++++++++++++++++++--------------------------- 3 files changed, 38 insertions(+), 35 deletions(-) diff --git a/doc/html/Datasets.html b/doc/html/Datasets.html index 16218cc..4520172 100644 --- a/doc/html/Datasets.html +++ b/doc/html/Datasets.html @@ -447,11 +447,15 @@ H5Pset_external (plist, "scan3.data", 0, 16); *name, hid_t type_id, hid_t space_id, hid_t create_plist_id)
A dataset is created by calling H5Dcreate with - a file identifier, a dataset name, a datatype, a data space, - and constant properties. The datatype and data space are the + a file identifier, a dataset name, a datatype, a dataspace, + and constant properties. The datatype and dataspace are the type and space of the dataset as it will exist in the file, - which may be different than in application memory. The - create_plist_id is a H5P_DATASET_CREATE + which may be different than in application memory. + Dataset names within a group must be unique: + H5Dcreate returns an error if a dataset with the + name specified in name already exists + at the location specified in file_id. + The create_plist_id is a H5P_DATASET_CREATE property list created with H5Pcreate() and initialized with the various functions described above. H5Dcreate() returns a dataset handle for success diff --git a/doc/html/Groups.html b/doc/html/Groups.html index 8aac8a7..44ca0fb 100644 --- a/doc/html/Groups.html +++ b/doc/html/Groups.html @@ -72,7 +72,7 @@ and a name which exists as a member of some other group. In this way, groups can be linked together to form a directed graph. One particular group is called the Root Group and is - the group to which the HDF5 file boot block points. Its name is + the group to which the HDF5 file super block points. Its name is "/" by convention. The full name of an object is created by joining component names with slashes much like Unix. @@ -181,6 +181,11 @@ +

Note, however, that object names within a group must be unique. + For example, H5Dcreate returns an error if a + dataset with the dataset name specified in the parameter list + already exists at the location specified in the parameter list. +

3. Creating, Opening, and Closing Groups

diff --git a/doc/html/References.html b/doc/html/References.html index bb38f55..014b622 100644 --- a/doc/html/References.html +++ b/doc/html/References.html @@ -51,7 +51,7 @@
-

The Reference Interface (H5R) and
the Indentifier Interface (H5I)

+

The Reference Interface (H5R) and
the Identifier Interface (H5I)

1. Introduction

@@ -70,8 +70,6 @@ implemented, or planned for implementation, in HDF5.
Object reference
Reference to an entire object in the current HDF5 file. -
- The only kind of reference currently implemented.

An object reference points to an entire object in the current HDF5 file by storing the relative file address @@ -82,8 +80,6 @@ implemented, or planned for implementation, in HDF5.

Dataset region reference
Reference to a specific dataset region. -
- Not yet implemented.

A dataset region reference points to a region of a dataset in the current HDF5 file by storing the OID @@ -92,16 +88,6 @@ implemented, or planned for implementation, in HDF5. by retrieving the coordinates of the areas in the region from the global heap. A dataset region reference is of a variable size in the file. -

-

Internal dataset region reference -
Reference to a region within the current dataset. -
- Not yet implemented. -

- An internal dataset region reference points to a - region of the current dataset by storing the - coordinates of the region. An internal dataset - region reference is of a fixed size in the file.

@@ -113,31 +99,30 @@ is deleted, moved, or not yet available.

3. Reference Types

-This section lists valid HDF5 reference types for use in the -H5R functions. +Valid HDF5 reference types for use in the H5R functions +are as follows:
+ - - -
Reference TypeValue  Description
H5R_OBJECT 0   Object reference
H5R_DATASET_REGION 1   Dataset region reference
H5R_INTERNAL2  Internal reference

4. Functions

-Four functions, three in the H5R interface and one in the +Five functions, four in the H5R interface and one in the H5I interface, have been implemented to support references. The H5I function is also useful outside the context of references.

@@ -166,6 +151,17 @@ The H5I function is also useful outside the context of references. dset.

+

int H5Rget_object_type(hid_t obj_id, + void *reference) +
H5Rget_object_type retrieves the type of object + that an object reference points to. + The parameter obj_id specifies the dataset + containing the reference object or the location identifier + of the object that the dataset is located within. + The parameter reference specifies the + reference being queried. +

+

H5S_t H5Rget_region(H5D_t dataset, H5R_type_t type, void *reference) @@ -183,19 +179,17 @@ The H5I function is also useful outside the context of references. in the following list:
- - - + - + - + - + - + - +
H5I_BADIDInvalid ID
H5I_FILE
H5I_FILE File objects
H5I_GROUP
H5I_GROUP Group objects
H5I_DATATYPE
H5I_DATATYPE Datatype objects
H5I_DATASPACE
H5I_DATASPACE Dataspace objects
H5I_DATASET
H5I_DATASET Dataset objects
H5I_ATTR
H5I_ATTR Attribute objects
@@ -527,7 +521,7 @@ Notes:
Disk Offset Reference
Points to a sequence of bytes in the current HDF5 file by storing the byte length and offset of the sequence within - the file, relative to the boot-block (as are all the other high-level + the file, relative to the super block (as are all the other high-level addresses used in the file). The offset is the absolute byte offset within the file, no interpretation of the data at that location is provided. Fixed size in file. -- cgit v0.12