summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorFrank Baker <fbaker@hdfgroup.org>2000-03-08 22:20:27 (GMT)
committerFrank Baker <fbaker@hdfgroup.org>2000-03-08 22:20:27 (GMT)
commitd216d71c168a46087c2334f07fadfa779ef288dc (patch)
tree4e57ab86b9ac58f4d170d749952b2f0fc4a968e7 /doc
parent4d57b9df226af87f092ea6833bff13c588e80caa (diff)
downloadhdf5-d216d71c168a46087c2334f07fadfa779ef288dc.zip
hdf5-d216d71c168a46087c2334f07fadfa779ef288dc.tar.gz
hdf5-d216d71c168a46087c2334f07fadfa779ef288dc.tar.bz2
[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.
Diffstat (limited to 'doc')
-rw-r--r--doc/html/Datasets.html12
-rw-r--r--doc/html/Groups.html7
-rw-r--r--doc/html/References.html54
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);
*<em>name</em>, hid_t <em>type_id</em>, hid_t
<em>space_id</em>, hid_t <em>create_plist_id</em>)</code>
<dd>A dataset is created by calling <code>H5Dcreate</code> 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
- <em>create_plist_id</em> is a <code>H5P_DATASET_CREATE</code>
+ which may be different than in application memory.
+ Dataset names within a group must be unique:
+ <code>H5Dcreate</code> returns an error if a dataset with the
+ name specified in <code><em>name</em></code> already exists
+ at the location specified in <code><em>file_id</em></code>.
+ The <em>create_plist_id</em> is a <code>H5P_DATASET_CREATE</code>
property list created with <code>H5Pcreate()</code> and
initialized with the various functions described above.
<code>H5Dcreate()</code> 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 <em>Root Group</em> 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 <em>full name</em> of an object is
created by joining component names with slashes much like Unix.
@@ -181,6 +181,11 @@
</table>
</center>
+ <p>Note, however, that object names within a group must be unique.
+ For example, <code>H5Dcreate</code> 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.
+
<h2>3. Creating, Opening, and Closing Groups</h2>
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 @@
<hr>
-<h1>The Reference Interface (H5R) and <br> the Indentifier Interface (H5I)</h1>
+<h1>The Reference Interface (H5R) and <br> the Identifier Interface (H5I)</h1>
<h2>1. Introduction</h2>
@@ -70,8 +70,6 @@ implemented, or planned for implementation, in HDF5.
<dl>
<dt>Object reference
<dd>Reference to an entire object in the current HDF5 file.
- <br>
- <em>The only kind of reference currently implemented.</em>
<p>
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.
<p>
<dt>Dataset region reference
<dd>Reference to a specific dataset region.
- <br>
- <em>Not yet implemented.</em>
<p>
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.
- <p>
- <dt>Internal dataset region reference
- <dd>Reference to a region within the current dataset.
- <br>
- <em>Not yet implemented.</em>
- <p>
- 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.
</dl>
@@ -113,31 +99,30 @@ is deleted, moved, or not yet available.
<h2>3. Reference Types</h2>
-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:
<center>
<table>
<tr><th align=left>Reference Type</th><th align=left>Value&nbsp;&nbsp;</th><th align=left>Description</th></tr>
+<!-- NOT USER-LEVEL INFORMATION; DELETED FROM HDF5 USER'S GUIDE
<tr><td><code>H5R_BADTYPE</code></td>
<td align=right><code>-1&nbsp;&nbsp;</code></td>
<td>Invalid reference type</td></tr>
+-->
<tr><td><code>H5R_OBJECT</code></td>
<td align=right><code>0&nbsp;&nbsp;</code></td>
<td>Object reference</td></tr>
<tr><td><code>H5R_DATASET_REGION</code></td>
<td align=right><code>1&nbsp;&nbsp;</code></td>
<td>Dataset region reference</td></tr>
-<tr><td><code>H5R_INTERNAL</code></td>
- <td align=right><code>2&nbsp;&nbsp;</code></td>
- <td>Internal reference</td></tr>
</table>
</center>
<h2>4. Functions</h2>
-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.
<p>
@@ -166,6 +151,17 @@ The H5I function is also useful outside the context of references.
<code>dset</code>.
<p>
+ <dt><em>int</em> <code>H5Rget_object_type(</code><em>hid_t</em> <code>obj_id,</code>
+ <em>void *</em><code>reference)</code>
+ <dd><code>H5Rget_object_type</code> retrieves the type of object
+ that an object reference points to.
+ The parameter <code>obj_id</code> specifies the dataset
+ containing the reference object or the location identifier
+ of the object that the dataset is located within.
+ The parameter <code>reference</code> specifies the
+ reference being queried.
+ <p>
+
<dt><em>H5S_t</em> <code>H5Rget_region(</code><em>H5D_t</em> <code>dataset,</code>
<em>H5R_type_t</em> <code>type,</code>
<em>void *</em><code>reference)</code>
@@ -183,19 +179,17 @@ The H5I function is also useful outside the context of references.
in the following list:
<center>
<table>
- <tr><td><code>H5I_BADID</code></td>
- <td>Invalid ID</td></tr>
- <tr><td><code>H5I_FILE</code></td>
+ <tr valign=bottom><td><code>H5I_FILE</code></td>
<td>File objects</td></tr>
- <tr><td><code>H5I_GROUP</code></td>
+ <tr valign=bottom><td><code>H5I_GROUP</code></td>
<td>Group objects</td></tr>
- <tr><td><code>H5I_DATATYPE</code></td>
+ <tr valign=bottom><td><code>H5I_DATATYPE</code></td>
<td>Datatype objects</td></tr>
- <tr><td><code>H5I_DATASPACE</code></td>
+ <tr valign=bottom><td><code>H5I_DATASPACE</code></td>
<td>Dataspace objects</td></tr>
- <tr><td><code>H5I_DATASET</code></td>
+ <tr valign=bottom><td><code>H5I_DATASET</code></td>
<td>Dataset objects</td></tr>
- <tr><td><code>H5I_ATTR</code></td>
+ <tr valign=bottom><td><code>H5I_ATTR</code></td>
<td>Attribute objects</td></tr>
</table>
</center>
@@ -527,7 +521,7 @@ Notes:
<dt>Disk Offset Reference
<dd>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.