diff options
| author | Frank Baker <fbaker@hdfgroup.org> | 1998-09-11 16:00:43 (GMT) |
|---|---|---|
| committer | Frank Baker <fbaker@hdfgroup.org> | 1998-09-11 16:00:43 (GMT) |
| commit | 3672cb4c1ce2e2bdda5ab95bd3782b610d4cd20f (patch) | |
| tree | a2b81075da2b9ab108ceeb6c620fc4adcf26838f /doc | |
| parent | f56f76eb1d5093fca7066f44a428d4b0235996b4 (diff) | |
| download | hdf5-3672cb4c1ce2e2bdda5ab95bd3782b610d4cd20f.zip hdf5-3672cb4c1ce2e2bdda5ab95bd3782b610d4cd20f.tar.gz hdf5-3672cb4c1ce2e2bdda5ab95bd3782b610d4cd20f.tar.bz2 | |
[svn-r693] Update for beta release. Complete CVS log messages can be found with
the versions of these files that are maintained in hdf5/doc/src/.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/html/Glossary.html | 36 | ||||
| -rw-r--r-- | doc/html/RM_H5.html | 41 | ||||
| -rw-r--r-- | doc/html/RM_H5A.html | 34 | ||||
| -rw-r--r-- | doc/html/RM_H5D.html | 30 | ||||
| -rw-r--r-- | doc/html/RM_H5E.html | 6 | ||||
| -rw-r--r-- | doc/html/RM_H5F.html | 46 | ||||
| -rw-r--r-- | doc/html/RM_H5Front.html | 30 | ||||
| -rw-r--r-- | doc/html/RM_H5G.html | 135 | ||||
| -rw-r--r-- | doc/html/RM_H5P.html | 431 | ||||
| -rw-r--r-- | doc/html/RM_H5R.html | 248 | ||||
| -rw-r--r-- | doc/html/RM_H5S.html | 278 | ||||
| -rw-r--r-- | doc/html/RM_H5T.html | 20 | ||||
| -rw-r--r-- | doc/html/RM_H5Z.html | 6 | ||||
| -rw-r--r-- | doc/html/Tools.html | 259 |
14 files changed, 1424 insertions, 176 deletions
diff --git a/doc/html/Glossary.html b/doc/html/Glossary.html index 31b2db6..9c727a4 100644 --- a/doc/html/Glossary.html +++ b/doc/html/Glossary.html @@ -25,23 +25,29 @@ Glossary <h1>HDF5 Glossary</h1> </center> -<i>(<b>Under construction!</b> - This is the bare beginning of a Glossary to accompany the HDF5 documentation; - it is by no means complete.)</i> +<i>(<b>Under construction!</b> + This is the bare beginning of a Glossary to accompany the HDF5 + documentation; it is by no means complete.)</i> -<ol type=A> - <li><a href="#Glossary-Basic">Basic Types</a> - <li><a href="#Glossary-Complex">Complex Types</a> - <li><a href="#Glossary-DiskIO">Disk I/O Types</a> -</ol> +<ul> + <li><a href="#Glossary-Basic">basic data types</a> + <li><a href="#Glossary-Complex">complex data types</a> + <li>data types +<ul> + <li><a href="#Glossary-Basic">basic data types</a> + <li><a href="#Glossary-Complex">complex data types</a> + <li><a href="#Glossary-DiskIO">disk I/O data types</a> +</ul> + <li><a href="#Glossary-DiskIO">disk I/O data types</a> +</ul> -<P>Since many of the typedefs in the HDF5 API are not well-defined yet, -the types below may change radically en route to a final API... <hr> -<a name="Glossary-Basic">Basic Types:</a> +<a name="Glossary-Basic">basic data types:</a> <ul> + <li><em>(Some data types may change substantially en route to + Release 1.0.)</em> <li>char - 8-bit character (only for ASCII information) <li>int8 - 8-bit signed integer <li>uint8 - 8-bit unsigned integer @@ -57,8 +63,10 @@ the types below may change radically en route to a final API... <li>float64 - 64-bit IEEE float </ul> -<a name="Glossary-Complex">Complex Types:</a> +<a name="Glossary-Complex">Complex data types:</a> <ul> + <li><em>(Some data types may change substantially en route to + Release 1.0.)</em> <li>hid_t - 32-bit unsigned integer used as ID for memory objects <li>hoid_t - 32-bit unsigned integer (currently) used as ID for disk-based objects @@ -66,8 +74,10 @@ the types below may change radically en route to a final API... <li>herr_t - 32-bit integer to indicate succeed/fail codes from functions </ul> -<a name="Glossary-DiskIO">Disk I/O Types:</a> +<a name="Glossary-DiskIO">disk I/O data types:</a> <ul> + <li><em>(Some data types may change substantially en route to + Release 1.0.)</em> <li>hoff_t - (64-bit?) offset on disk in bytes <li>hlen_t - (64-bit?) length on disk in bytes </ul> diff --git a/doc/html/RM_H5.html b/doc/html/RM_H5.html index 8b2ab70..ad2cb8d 100644 --- a/doc/html/RM_H5.html +++ b/doc/html/RM_H5.html @@ -18,7 +18,10 @@ H5 <a href="RM_H5S.html">H5S</a> <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> +<a href="Tools.html">Tools</a> +<!-- <a href="Glossary.html">Glossary</a> +--> </center> <hr> @@ -37,8 +40,8 @@ and it users. </ul> </td><td> </td><td valign=top> <ul> - <li><a href="#Library-Version">H5version</a> - <li><a href="#Library-VersCheck">H5vers_check</a> + <li><a href="#Library-Version">H5get_libversion</a> + <li><a href="#Library-VersCheck">H5check_version</a> </ul> </td><td> </td><td valign=top> <ul> @@ -127,18 +130,18 @@ and it users. <hr> <dl> -<dt><strong>Name:</strong> <a name="Library-Version">H5version</a> +<dt><strong>Name:</strong> <a name="Library-Version">H5get_libversion</a> <dt><strong>Signature:</strong> - <dd><em>herr_t</em> <code>H5version</code>(<em>unsigned *</em><code>majnum</code>, + <dd><em>herr_t</em> <code>H5get_libversion</code>(<em>unsigned *</em><code>majnum</code>, <em>unsigned *</em><code>minnum</code>, - <em>unsigned *</em><code>relnum</code>, - <em>unsigned *</em><code>patnum</code> + <em>unsigned *</em><code>relnum</code> ) <dt><strong>Purpose:</strong> - <dd> + <dd>Returns the HDF library release number. <dt><strong>Description:</strong> - <dd><code>H5version</code> retrieves the major, minor, release, and - patch versions of the library which is linked to the application. + <dd><code>H5get_libversion</code> retrieves the major, minor, and release + numbers of the version of the HDF library which is linked to + the application. <dt><strong>Parameters:</strong> <dl> <dt><em>unsigned *</em><code>majnum</code> @@ -147,8 +150,6 @@ and it users. <dd>The minor version of the library. <dt><em>unsigned *</em><code>relnum</code> <dd>The release number of the library. - <dt><em>unsigned *</em><code>patnum</code> - <dd>The patch number of the library. </dl> <dt><strong>Returns:</strong> <dd>Returns SUCCEED (0) if successful; @@ -158,23 +159,22 @@ and it users. <hr> <dl> -<dt><strong>Name:</strong> <a name="Library-VersCheck">H5vers_check</a> +<dt><strong>Name:</strong> <a name="Library-VersCheck">H5check_version</a> <dt><strong>Signature:</strong> - <dd><em>herr_t</em> <code>H5vers_check</code>(<em>unsigned *</em><code>majnum</code>, - <em>unsigned *</em><code>minnum</code>, - <em>unsigned *</em><code>relnum</code>, - <em>unsigned *</em><code>patnum</code> + <dd><em>herr_t</em> <code>H5check_version</code>(<em>unsigned</em> <code>majnum</code>, + <em>unsigned</em> <code>minnum</code>, + <em>unsigned</em> <code>relnum</code> ) <dt><strong>Purpose:</strong> <dd> <dt><strong>Description:</strong> - <dd><code>H5vers_check</code> verifies that the arguments match the + <dd><code>H5check_version</code> verifies that the arguments match the version numbers compiled into the library. This function is intended to be called from user to verify that the versions of header files compiled into the application match the version of the HDF5 library. <p> Due to the risks of data corruption or segmentation faults, - <code>H5vers_check</code> causes the application to abort if the + <code>H5check_version</code> causes the application to abort if the version numbers do not match. <dt><strong>Parameters:</strong> <dl> @@ -206,7 +206,10 @@ H5 <a href="RM_H5S.html">H5S</a> <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> +<a href="Tools.html">Tools</a> +<!-- <a href="Glossary.html">Glossary</a> +--> </center> <hr> @@ -214,7 +217,7 @@ H5 <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 14 July 1998 +Last modified: 2 September 1998 </body> </html> diff --git a/doc/html/RM_H5A.html b/doc/html/RM_H5A.html index 0c236da..bda4333 100644 --- a/doc/html/RM_H5A.html +++ b/doc/html/RM_H5A.html @@ -18,7 +18,10 @@ H5A <a href="RM_H5S.html">H5S</a> <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> +<a href="Tools.html">Tools</a> +<!-- <a href="Glossary.html">Glossary</a> +--> </center> <hr> @@ -49,7 +52,7 @@ and information about attributes. </td><td> </td><td valign=top> <ul> <li><a href="#Annot-GetType">H5Aget_type</a> - <li><a href="#Annot-NumAttrs">H5Anum_attrs</a> + <li><a href="#Annot-NumAttrs">H5Aget_num_attrs</a> <li><a href="#Annot-Iterate">H5Aiterate</a> <li><a href="#Annot-Delete">H5Adelete</a> </ul> @@ -107,7 +110,7 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: Object (dataset or group) to be attached to. + <dd>IN: Object (dataset, group, or named datatype) to be attached to. <dt><em>const char *</em><code>name</code> <dd>IN: Name of attribute to create. <dt><em>hid_t</em> <code>type_id</code> @@ -203,6 +206,14 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the <code>attr_id</code>. The attribute's memory datatype is specified with <code>mem_type_id</code>. The entire attribute is written from <code>buf</code> to the file. + <p> + Datatype conversion takes place at the time of a read or write + and is automatic. See the + <a href="Datatypes.html#Datatypes-DataConversion">Data Conversion</a> + section of <cite>The Data Type Interface (H5T)</cite> in the + <cite>HDF5 User's Guide</cite> for a discussion of + data conversion, including the range of conversions currently + supported by the HDF5 libraries. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>attr_id</code> @@ -233,6 +244,14 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the <code>attr_id</code>. The attribute's memory datatype is specified with <code>mem_type_id</code>. The entire attribute is read into <code>buf</code> from the file. + <p> + Datatype conversion takes place at the time of a read or write + and is automatic. See the + <a href="Datatypes.html#Datatypes-DataConversion">Data Conversion</a> + section of <cite>The Data Type Interface (H5T)</cite> in the + <cite>HDF5 User's Guide</cite> for a discussion of + data conversion, including the range of conversions currently + supported by the HDF5 libraries. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>attr_id</code> @@ -336,13 +355,13 @@ See <a href="Attributes.html"><cite>Attributes</cite></a> in the <hr> <dl> -<dt><strong>Name:</strong> <a name="Annot-NumAttrs">H5Anum_attrs</a> +<dt><strong>Name:</strong> <a name="Annot-NumAttrs">H5Aget_num_attrs</a> <dt><strong>Signature:</strong> - <dd><em>int</em> <code>H5Anum_attrs</code>(<em>hid_t</em> <code>loc_id</code>) + <dd><em>int</em> <code>H5Aget_num_attrs</code>(<em>hid_t</em> <code>loc_id</code>) <dt><strong>Purpose:</strong> <dd>Determines the number of attributes attached to an object. <dt><strong>Description:</strong> - <dd><code>H5Anum_attrs</code> returns the number of attributes + <dd><code>H5Aget_num_attrs</code> returns the number of attributes attached to the object specified by its identifier, <code>loc_id</code>. The object can be a group, dataset, or named datatype. @@ -487,7 +506,10 @@ H5A <a href="RM_H5S.html">H5S</a> <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> +<a href="Tools.html">Tools</a> +<!-- <a href="Glossary.html">Glossary</a> +--> </center> <hr> @@ -495,7 +517,7 @@ H5A <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 14 July 1998 +Last modified: 1 September 1998 </body> </html> diff --git a/doc/html/RM_H5D.html b/doc/html/RM_H5D.html index 7b5263d..bb2c4dc 100644 --- a/doc/html/RM_H5D.html +++ b/doc/html/RM_H5D.html @@ -18,7 +18,10 @@ H5D <a href="RM_H5S.html">H5S</a> <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> +<a href="Tools.html">Tools</a> +<!-- <a href="Glossary.html">Glossary</a> +--> </center> <hr> @@ -120,7 +123,8 @@ and set and retrieve their constant or persistent properties. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>loc_id</code> - <dd>Identifier of the file to access the dataset within. + <dd>Identifier of the dataset to open or the file or group + to access the dataset within. <dt><em>const char *</em> <code>name</code> <dd>The name of the dataset to access. </dl> @@ -246,6 +250,14 @@ and set and retrieve their constant or persistent properties. <code>xfer_plist_id</code> can be the constant <code>H5P_DEFAULT</code>, in which case the default data transfer properties are used. + <p> + Datatype conversion takes place at the time of a read or write + and is automatic. See the + <a href="Datatypes.html#Datatypes-DataConversion">Data Conversion</a> + section of <cite>The Data Type Interface (H5T)</cite> in the + <cite>HDF5 User's Guide</cite> for a discussion of + data conversion, including the range of conversions currently + supported by the HDF5 libraries. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>dataset_id</code> @@ -305,6 +317,17 @@ and set and retrieve their constant or persistent properties. <p> <code>xfer_plist_id</code> can be the constant <code>H5P_DEFAULT</code>. in which case the default data transfer properties are used. + <p> + Writing to an external dataset will fail if the HDF5 file is + not open for writing. + <p> + Datatype conversion takes place at the time of a read or write + and is automatic. See the + <a href="Datatypes.html#Datatypes-DataConversion">Data Conversion</a> + section of <cite>The Data Type Interface (H5T)</cite> in the + <cite>HDF5 User's Guide</cite> for a discussion of + data conversion, including the range of conversions currently + supported by the HDF5 libraries. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>dataset_id</code> @@ -391,7 +414,10 @@ H5D <a href="RM_H5S.html">H5S</a> <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> +<a href="Tools.html">Tools</a> +<!-- <a href="Glossary.html">Glossary</a> +--> </center> <hr> @@ -399,7 +425,7 @@ H5D <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 14 July 1998 +Last modified: 12 August 1998 </body> </html> diff --git a/doc/html/RM_H5E.html b/doc/html/RM_H5E.html index e3c8177..d29380e 100644 --- a/doc/html/RM_H5E.html +++ b/doc/html/RM_H5E.html @@ -18,7 +18,10 @@ H5E <a href="RM_H5S.html">H5S</a> <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> +<a href="Tools.html">Tools</a> +<!-- <a href="Glossary.html">Glossary</a> +--> </center> <hr> @@ -347,7 +350,10 @@ H5E <a href="RM_H5S.html">H5S</a> <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> +<a href="Tools.html">Tools</a> +<!-- <a href="Glossary.html">Glossary</a> +--> </center> <hr> diff --git a/doc/html/RM_H5F.html b/doc/html/RM_H5F.html index cbb0a48..5ecc148 100644 --- a/doc/html/RM_H5F.html +++ b/doc/html/RM_H5F.html @@ -18,7 +18,10 @@ H5F <a href="RM_H5S.html">H5S</a> <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> +<a href="Tools.html">Tools</a> +<!-- <a href="Glossary.html">Glossary</a> +--> </center> <hr> @@ -37,10 +40,11 @@ documented below. <ul> <li><a href="#File-Open">H5Fopen</a> <li><a href="#File-Create">H5Fcreate</a> + <li><a href="#File-IsHDF5">H5Fis_hdf5</a> </ul> </td><td> </td><td valign=top> <ul> - <li><a href="#File-IsHDF5">H5Fis_hdf5</a> + <li><a href="#File-Flush">H5Fflush</a> <li><a href="#File-Close">H5Fclose</a> </ul> </td><td> </td><td valign=top> @@ -126,8 +130,8 @@ documented below. The more complex behaviors of file creation and access are controlled through the file-creation and file-access property lists. The value of <code>H5P_DEFAULT</code> for - a property list value indicates that the library should use - the default values for the appropriate property list. Also see + a property list value indicates that the library should use + the default values for the appropriate property list. Also see <code>H5Fpublic.h</code> for the list of supported flags. <dt><strong>Parameters:</strong> <dl> @@ -151,13 +155,13 @@ documented below. <dd>Apply default file access and creation properties. </dl></ul> <dt><em>hid_t</em> <code>create_id</code> - <dd>File creation property list identifier, used when modifying + <dd>File creation property list identifier, used when modifying default file meta-data. <dt><em>hid_t</em> <code>access_id</code> <dd>File access property list identifier. If parallel file access is desired, this is a collective call according to the communicator stored in the - <code>access_id</code>. + <code>access_id</code>. Use <code>0</code> for default access properties. </dl> <dt><strong>Returns:</strong> @@ -168,6 +172,33 @@ documented below. <hr> <dl> +<dt><strong>Name:</strong> <a name="File-Flush">H5Fflush</a> +<dt><strong>Signature:</strong> + <dd><em>herr_t </em><code>H5Fis_hdf5</code>(<em>hid_t </em><code>object_id</code> + ) +<dt><strong>Purpose:</strong> + <dd>Flushes all buffers associated with a file to disk. +<dt><strong>Description:</strong> + <dd><code>H5Fflush</code> causes all buffers associated with a + file to be immediately flushed to disk without removing the + data from the cache. + <p> + <code>object_id</code> can be any object associated with the file, + including the file itself, a dataset, a group, an attribute, or + a named data type. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>const char *</em><code>object_id</code> + <dd>Identifier of object used to identify the file. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns SUCCEED (0) if successful; + otherwise returns FAIL (-1). +</dl> + + +<hr> +<dl> <dt><strong>Name:</strong> <a name="File-IsHDF5">H5Fis_hdf5</a> <dt><strong>Signature:</strong> <dd><em>hbool_t </em><code>H5Fis_hdf5</code>(<em>const char *</em><code>name</code> @@ -286,7 +317,10 @@ H5F <a href="RM_H5S.html">H5S</a> <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> +<a href="Tools.html">Tools</a> +<!-- <a href="Glossary.html">Glossary</a> +--> </center> <hr> @@ -294,7 +328,7 @@ H5F <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 14 July 1998 +Last modified: 14 August 1998 </body> </html> diff --git a/doc/html/RM_H5Front.html b/doc/html/RM_H5Front.html index 5d8b601..c3701b8 100644 --- a/doc/html/RM_H5Front.html +++ b/doc/html/RM_H5Front.html @@ -14,10 +14,16 @@ HDF5 Reference Manual <a href="RM_H5F.html">H5F</a> <a href="RM_H5G.html">H5G</a> <a href="RM_H5P.html">H5P</a> +<!-- +<a href="RM_H5R.html">H5R</a> +--> <a href="RM_H5S.html">H5S</a> <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> +<a href="Tools.html">Tools</a> +<!-- <a href="Glossary.html">Glossary</a> +--> </center> <hr> @@ -40,7 +46,14 @@ tools required to meet specific aspects of the HDF5 data-handling requirements. <li><a href="RM_H5E.html">Error Interface</a> -- The <strong>H5E</strong> API for error handling. <li><a href="RM_H5Z.html">Compression Interface</a> -- The <strong>H5Z</strong> API for compression. <li><a href="RM_H5A.html">Annotation Interface</a> -- The <strong>H5A</strong> API for annotations. +<li><a href="Tools.html">Tools</a> -- Interactive tools for the examination of existing HDF5 files. +<!-- <li><a href="Glossary.html">Glossary</a> -- A glossary of data-types used in the APIs. +--> +<!-- +<hr> +<li>Experimental interface:<a href="RM_H5R.html">Ragged Arrays</a> -- The <strong>H5R</strong> API for ragged arrays. +--> </ul> @@ -55,18 +68,31 @@ HDF5 Reference Manual <a href="RM_H5F.html">H5F</a> <a href="RM_H5G.html">H5G</a> <a href="RM_H5P.html">H5P</a> +<!-- +<a href="RM_H5R.html">H5R</a> +--> <a href="RM_H5S.html">H5S</a> <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> +<a href="Tools.html">Tools</a> +<!-- <a href="Glossary.html">Glossary</a> +--> </center> <hr> <address> +<table width=100% border=0> +<tr><td align=left valign=top> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> - <br> -Last modified: 14 July 1998 +Last modified: 8 September 1998 + +</td><td align=right valign=top> +<a href="Copyright.html">Copyright</a> +</td></tr> +</table> + </body> </html> diff --git a/doc/html/RM_H5G.html b/doc/html/RM_H5G.html index 55b7d5b..9b0a8a0 100644 --- a/doc/html/RM_H5G.html +++ b/doc/html/RM_H5G.html @@ -18,7 +18,10 @@ H5G <a href="RM_H5S.html">H5S</a> <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> +<a href="Tools.html">Tools</a> +<!-- <a href="Glossary.html">Glossary</a> +--> </center> <hr> @@ -38,20 +41,22 @@ of objects on disk. <li><a href="#Group-Open">H5Gopen</a> <li><a href="#Group-Set">H5Gset</a> <li><a href="#Group-Close">H5Gclose</a> + <li><a href="#Group-Push">H5Gpush</a> </ul> </td><td> </td><td valign=top> <ul> - <li><a href="#Group-Push">H5Gpush</a> <li><a href="#Group-Pop">H5Gpop</a> <li><a href="#Group-Link">H5Glink</a> <li><a href="#Group-Unlink">H5Gunlink</a> (NYI) + <li><a href="#Group-Iterate">H5Giterate</a> + <li><a href="#Group-Move">H5Gmove</a> (NYI) </ul> </td><td> </td><td valign=top> <ul> - <li><a href="#Group-Iterate">H5Giterate</a> - <li><a href="#Group-Move">H5Gmove</a> (NYI) - <li><a href="#Group-Stat">H5Gstat</a> + <li><a href="#Group-GetObjinfo">H5Gget_objinfo</a> <li><a href="#Group-GetLinkval">H5Gget_linkval</a> + <li><a href="#Group-SetComment">H5Gset_comment</a> + <li><a href="#Group-GetComment">H5Gget_comment</a> </ul> </td></tr><tr><td colspan=5 align=right> <font size=-2>(NYI = Not yet implemented)</font> @@ -279,7 +284,7 @@ then be trivial. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>loc_id</code> - <dd>The file or group identifier. + <dd>The file, group, dataset, or datatype identifier. </dl> <dt><strong>Returns:</strong> <dd>Returns SUCCEED (0) if successful; @@ -343,7 +348,7 @@ then be trivial. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>loc_id</code> - <dd>File or group identifier. + <dd>File, group, dataset, or datatype identifier. <dt><em>H5G_link_t</em> <code>link_type</code> <dd>Link type. Possible values are <code>H5G_LINK_HARD</code> and <code>H5G_LINK_SOFT</code>. @@ -501,9 +506,9 @@ then be trivial. <hr> <dl> - <dt><strong>Name:</strong> <a name="Group-Stat">H5Gstat</a> + <dt><strong>Name:</strong> <a name="Group-GetObjinfo">H5Gget_objinfo</a> <dt><strong>Signature:</strong> - <dd><em>herr_t</em> <code>H5Gstat</code>(<em>hid_t</em> <code>loc_id</code>, + <dd><em>herr_t</em> <code>H5Gget_objinfo</code>(<em>hid_t</em> <code>loc_id</code>, <em>const char *</em><code>name</code>, <em>hbool_t</em> <code>follow_link</code>, <em>H5G_stat_t *</em><code>statbuf</code> @@ -511,7 +516,7 @@ then be trivial. <dt><strong>Purpose:</strong> <dd>Returns information about an object. <dt><strong>Description:</strong> - <dd><code>H5Gstat</code> returns information about the + <dd><code>H5Gget_objinfo</code> returns information about the specified object through the <code>statbuf</code> argument. <code>loc_id</code> (a file, group, or dataset identifier) and <code>name</code> together determine the object. @@ -525,13 +530,14 @@ then be trivial. The existence of an object can be tested by calling this function with a null <code>statbuf</code>. <p> - <code>H5Gstat()</code> fills in the following data structure: + <code>H5Gget_objinfo()</code> fills in the following data structure: <pre> typedef struct H5G_stat_t { unsigned long fileno[2]; unsigned long objno[2]; unsigned nlink; H5G_type_t type; + time_t mtime; size_t linklen; } H5G_stat_t </pre> @@ -547,15 +553,20 @@ then be trivial. The <code>type</code> field contains the type of the object, one of <code>H5G_GROUP</code>, <code>H5G_DATASET</code>, or <code>H5G_LINK</code>. + The <code>mtime</code> field contains the modification time. If information is being returned about a symbolic link then <code>linklen</code> will be the length of the link value (the name of the pointed-to object with the null terminator); otherwise <code>linklen</code> will be zero. Other fields may be added to this structure in the future. + <dt><strong>Note:</strong> + <dd>Some systems will be able to record the time accurately but + unable to retrieve the correct time; such systems (e.g., Irix64) + will report an <code>mtime</code> value of 0 (zero). <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: File, group, or dataset identifier. + <dd>IN: File, group, dataset, or datatype identifier. <dt><em>const char</em> <code>*name</code> <dd>IN: Name of the object for which status is being sought. <dt><em>hbool_t</em> <code>follow_link</code> @@ -564,7 +575,8 @@ then be trivial. <dd>OUT: Buffer in which to return information about the object. </dl> <dt><strong>Returns:</strong> - <dd> Returns SUCCEED (0) with the fields of STATBUF (if non-null) initialized. + <dd> Returns SUCCEED (0) with the fields of <code>statbuf</code> + (if non-null) initialized. Otherwise returns FAIL (-1). </dl> @@ -592,11 +604,11 @@ then be trivial. The presence of a symbolic link can be tested by passing zero for <code>size</code> and NULL for <code>value</code>. <p> - Use <code>H5Gstat()</code> to get the size of a link value. + Use <code>H5Gget_objinfo()</code> to get the size of a link value. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: Identifier of the file or group . + <dd>IN: Identifier of the file, group, dataset, or datatype. <dt><em>const char *</em><code>name</code> <dd>IN: Name of the object whose link value is to be checked. <dt><em>size_t</em> <code>size</code> @@ -612,6 +624,96 @@ then be trivial. </dl> + + + + +<hr> +<dl> + <dt><strong>Name:</strong> <a name="Group-SetComment">H5Gset_comment</a> + <dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Gset_comment</code>(<em>hid_t</em> <code>loc_id</code>, + <em>const char *</em><code>name</code>, + <em>const char *</em><code>comment</code> + ) + <dt><strong>Purpose:</strong> + <dd>Sets comment for specified object. + <dt><strong>Description:</strong> + <dd><code>H5Gset_comment</code> sets the comment for the the + object <code>name</code> to <code>comment</code>. + Any previously existing comment is overwritten. + <p> + If <code>comment</code> is the empty string or a + null pointer, the comment message is removed from the object. + <p> + Comments should be relatively short, null-terminated, + ASCII strings. + <p> + Comments can be attached to any object that has an object header, + e.g., data sets, groups, named data types, and data spaces, but + not symbolic links. + <dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>loc_id</code> + <dd>IN: Identifier of the file, group, dataset, or datatype. + <dt><em>const char *</em><code>name</code> + <dd>IN: Name of the object whose comment is to be set or reset. + <dt><em>const char *</em><code>comment</code> + <dd>IN: The new comment. + </dl> + <dt><strong>Returns:</strong> + <dd>Returns SUCCEED (0) if successful; + otherwise returns FAIL (-1). +</dl> + + +<hr> +<dl> + <dt><strong>Name:</strong> <a name="Group-GetComment">H5Gget_comment</a> + <dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Gget_comment</code>(<em>hid_t</em> <code>loc_id</code>, + <em>const char *</em><code>name</code>, + <em>size_t</em> <code>bufsize</code>, + <em>char *</em><code>comment</code> + ) + <dt><strong>Purpose:</strong> + <dd>Retrieves comment for specified object. + <dt><strong>Description:</strong> + <dd><code>H5Gget_comment</code> retrieves the comment for the the + object <code>name</code>. The comment is returned in the buffer + <code>comment</code>. + <p> + At most <code>bufsize</code> characters, including a null + terminator, are copied. The result is not null terminated + if the comment is longer than the supplied buffer. + <p> + If an object does not have a comment, the empty string + is returned. + <dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>loc_id</code> + <dd>IN: Identifier of the file, group, dataset, or datatype. + <dt><em>const char *</em><code>name</code> + <dd>IN: Name of the object whose comment is to be set or reset. + <dt><em>size_t</em> <code>bufsize</code> + <dd>IN: Anticipated size of the buffer required to hold + <code>comment</code>. + <dt><em>char *</em><code>comment</code> + <dd>OUT: The comment. + </dl> + <dt><strong>Returns:</strong> + <dd>Returns the number of characters in the comment, + counting the null terminator, if successful; the value + returned may be larger than <code>bufsize</code>. + Otherwise returns FAIL (-1). +</dl> + + + + + + + <hr> <center> <a href="RM_H5Front.html">HDF5 Reference Manual</a> @@ -625,7 +727,10 @@ H5G <a href="RM_H5S.html">H5S</a> <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> +<a href="Tools.html">Tools</a> +<!-- <a href="Glossary.html">Glossary</a> +--> </center> <hr> @@ -633,7 +738,7 @@ H5G <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 14 July 1998 +Last modified: 2 September 1998 </body> </html> diff --git a/doc/html/RM_H5P.html b/doc/html/RM_H5P.html index 5329ec1..d9f1191 100644 --- a/doc/html/RM_H5P.html +++ b/doc/html/RM_H5P.html @@ -18,14 +18,16 @@ H5P <a href="RM_H5S.html">H5S</a> <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> +<a href="Tools.html">Tools</a> +<!-- <a href="Glossary.html">Glossary</a> +--> </center> <hr> <center> <h1>H5P: Property List Interface</h1> </center> - <h2>Property List API Functions</h2> These functions manipulate property list objects to allow objects which require @@ -88,9 +90,14 @@ many different parameters to be easily manipulated. <li><a href="#Property-SetChunk">H5Pset_chunk</a> <li><a href="#Property-GetChunk">H5Pget_chunk</a> <li><a href="#Property-SetDeflate">H5Pset_deflate</a> +<!-- <li><a href="#Property-GetDeflate">H5Pget_deflate</a> <li><a href="#Property-SetCompression">H5Pset_compression</a> <li><a href="#Property-GetCompression">H5Pget_compression</a> +--> + <li><a href="#Property-SetFilter">H5Pset_filter</a> + <li><a href="#Property-GetNFilters">H5Pget_nfilters</a> + <li><a href="#Property-GetFilter">H5Pget_filter</a> <li><a href="#Property-SetExternal">H5Pset_external</a> <li><a href="#Property-GetExternalCount">H5Pget_external_count</a> <li><a href="#Property-GetExternal">H5Pget_external</a> @@ -161,7 +168,6 @@ many different parameters to be easily manipulated. otherwise Fail (-1). </dl> - <hr> <dl> <dt><strong>Name:</strong> <a name="Property-Close">H5Pclose</a> @@ -439,7 +445,7 @@ many different parameters to be easily manipulated. <dd><code>H5Pget_mpi</code> retrieves the communicator and info object that have been set by H5Pset_mpi. This function is available only in the parallel HDF5 library - and is not a collective function. + and is not a collective function. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>plist</code> @@ -504,10 +510,10 @@ many different parameters to be easily manipulated. <dt><strong>Purpose:</strong> <dd>Retrieves the transfer mode from the dataset transfer property list. <dt><strong>Description:</strong> - <dd><code>H5Pget_xfer</code> retrieves the transfer mode from the dataset - transfer property list. + <dd><code>H5Pget_xfer</code> retrieves the transfer mode from the + dataset transfer property list. This function is available only in the parallel HDF5 library - and is not a collective function. + and is not a collective function. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>plist</code> @@ -532,22 +538,23 @@ many different parameters to be easily manipulated. <dt><strong>Purpose:</strong> <dd>Sets the size of parameters used to control the symbol table nodes. <dt><strong>Description:</strong> - <dd><code>H5Pset_sym_k</code> sets the size of parameters used to control the - symbol table nodes. This function is only valid for - file creation property lists. Passing in a value of 0 for one of the - parameters retains the current value. + <dd><code>H5Pset_sym_k</code> sets the size of parameters used to + control the symbol table nodes. This function is only valid + for file creation property lists. Passing in a value of 0 for + one of the parameters retains the current value. <p> <code>ik</code> is one half the rank of a tree that stores a symbol table for a group. Internal nodes of the symbol table are on average 75% full. That is, the average rank of the tree is 1.5 times the value of <code>ik</code>. <p> - <code>lk</code> is one half of the number of symbols that can be stored in - a symbol table node. A symbol table node is the leaf of a - symbol table tree which is used to store a group. When - symbols are inserted randomly into a group, the group's + <code>lk</code> is one half of the number of symbols that can + be stored in a symbol table node. A symbol table node is the + leaf of a symbol table tree which is used to store a group. + When symbols are inserted randomly into a group, the group's symbol table nodes are 75% full on average. That is, they - contain 1.5 times the number of symbols specified by <code>lk</code>. + contain 1.5 times the number of symbols specified by + <code>lk</code>. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>plist</code> @@ -576,11 +583,12 @@ many different parameters to be easily manipulated. and the symbol table leaf node 1/2 size. <dt><strong>Description:</strong> <dd><code>H5Pget_sym_k</code> retrieves the size of the - symbol table B-tree 1/2 rank and the symbol table leaf node 1/2 size. - This function is only valid for file creationproperty lists. - If a parameter valued is set to NULL, that parameter is not retrieved. - See the description for <a href="#Property-SetSymK">H5Pset_sym_k</a> - for more information. + symbol table B-tree 1/2 rank and the symbol table leaf + node 1/2 size. This function is only valid for file creation + property lists. If a parameter valued is set to NULL, that + parameter is not retrieved. See the description for + <a href="#Property-SetSymK">H5Pset_sym_k</a> for more + information. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>plist</code> @@ -607,14 +615,16 @@ many different parameters to be easily manipulated. <dd>Sets the size of the parameter used to control the B-trees for indexing chunked datasets. <dt><strong>Description:</strong> - <dd><code>H5Pset_istore_k</code> sets the size of the parameter used to control the - B-trees for indexing chunked datasets. This function is only valid for - file creation property lists. Passing in a value of 0 for one of the - parameters retains the current value. + <dd><code>H5Pset_istore_k</code> sets the size of the parameter + used to control the B-trees for indexing chunked datasets. + This function is only valid for file creation property lists. + Passing in a value of 0 for one of the parameters retains + the current value. <p> - <code>ik</code> is one half the rank of a tree that stores chunked raw - data. On average, such a tree will be 75% full, or have an - average rank of 1.5 times the value of <code>ik</code>. + <code>ik</code> is one half the rank of a tree that stores + chunked raw data. On average, such a tree will be 75% full, + or have an average rank of 1.5 times the value of + <code>ik</code>. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>plist</code> @@ -705,9 +715,9 @@ many different parameters to be easily manipulated. <dt><strong>Purpose:</strong> <dd>Returns the layout of the raw data for a dataset. <dt><strong>Description:</strong> - <dd><code>H5Pget_layout</code> returns the layout of the raw data for a dataset. - This function is only valid for dataset creation property lists. - Valid types for <code>layout</code> are: + <dd><code>H5Pget_layout</code> returns the layout of the raw data for + a dataset. This function is only valid for dataset creation + property lists. Valid types for <code>layout</code> are: <ul> <dl> <dt>H5D_COMPACT <dd>Raw data and object header stored contiguously in file. @@ -741,13 +751,14 @@ many different parameters to be easily manipulated. <dt><strong>Purpose:</strong> <dd>Sets the size of the chunks used to store a chunked layout dataset. <dt><strong>Description:</strong> - <dd><code>H5Pset_chunk</code> sets the size of the chunks used to store a chunked - layout dataset. This function is only valid for dataset creation - property lists. The <code>ndims</code> parameter currently must be the - same size as the rank of the dataset. The values of the - <code>dim</code> array define the size of the chunks to store the - dataset's raw data. As a side-effect, the layout of the dataset is - changed to H5D_CHUNKED, if it isn't already. + <dd><code>H5Pset_chunk</code> sets the size of the chunks used to + store a chunked layout dataset. This function is only valid + for dataset creation property lists. + The <code>ndims</code> parameter currently must be the same size + as the rank of the dataset. The values of the <code>dim</code> + array define the size of the chunks to store the dataset's raw data. + As a side-effect, the layout of the dataset is changed to + <code>H5D_CHUNKED</code>, if it is not already. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>plist</code> @@ -773,6 +784,7 @@ many different parameters to be easily manipulated. ) <dt><strong>Purpose:</strong> <dd>Retrieves the size of chunks for the raw data of a chunked layout dataset. + <dt><strong>Description:</strong> <dd><code>H5Pget_chunk</code> retrieves the size of chunks for the raw data of a chunked layout dataset. @@ -940,8 +952,8 @@ many different parameters to be easily manipulated. <dt><strong>Purpose:</strong> <dd>Returns information about an external file. <dt><strong>Description:</strong> - <dd><code>H5Pget_external</code> returns information about an external file. - The external file is specified by its index, <code>idx</code>, + <dd><code>H5Pget_external</code> returns information about an external + file. The external file is specified by its index, <code>idx</code>, which is a number from zero to N-1, where N is the value returned by <code>H5Pget_external_count()</code>. At most <code>name_size</code> characters are copied into the @@ -977,6 +989,189 @@ many different parameters to be easily manipulated. <hr> <dl> + <dt><strong>Name:</strong> <a name="Property-SetFilter">H5Pset_filter</a> + <dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Pset_filter</code>(<em>hid_t</em> <code>plist</code>, + <em>H5Z_filter_t</em> <code>filter</code>, + <em>unsigned int</em> <code>flags</code>, + <em>size_t</em> <code>cd_nelmts</code>, + <em>const unsigned int</em> <code>cd_values[]</code> + ) + <dt><strong>Purpose:</strong> + <dd>Adds a filter to the filter pipeline. + <dt><strong>Description:</strong> + <dd><code>H5Pset_filter</code> adds the specified + <code>filter</code> and corresponding properties to the + end of an output filter pipeline. + If <code>plist</code> is a dataset creation property list, + the filter is added to the permanent filter pipeline; + if <code>plist</code> is a dataset transfer property list, + the filter is added to the transient filter pipeline. + <p> + The array <code>cd_values</code> contains + <code>cd_nelmts</code> integers which are auxiliary data + for the filter. The integer values will be stored in the + dataset object header as part of the filter information. + <p> + The <code>flags</code> argument is a bit vector with + the following fields specifying certain general properties + of the filter: + <center> + <table align=center width="80%"> + <tr valign=top> + <td valign=top><code>H5Z_FLAG_OPTIONAL</code></td> + <td> </td> + <td valign=top>If this bit is set then the filter is + optional. If the filter fails (see below) during an + <code>H5Dwrite()</code> operation then the filter is + just excluded from the pipeline for the chunk for which + it failed; the filter will not participate in the + pipeline during an <code>H5Dread()</code> of the chunk. + This is commonly used for compression filters: if the + compression result would be larger than the input then + the compression filter returns failure and the + uncompressed data is stored in the file. If this bit is + clear and a filter fails then <code>H5Dwrite()</code> + or <code>H5Dread()</code> also fails.</td> + </tr> + </table> + </center> + <dt><strong>Note:</strong> + <dd>This function currently supports only the permanent filter + pipeline; <code>plist_id</code> must be a dataset creation + property list. + <dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>plist</code> + <dd>IN: Property list identifier. + <dt><em>H5Z_filter_t</em> <code>filter</code> + <dd>IN: Filter to be added to the pipeline. + <dt><em>unsigned int</em> <code>flags</code> + <dd>IN: Bit vector specifying certain general properties + of the filter. + <dt><em>size_t</em> <code>cd_nelmts</code> + <dd>IN: Number of elements in <code>cd_values</code> + <dt><em>const unsigned int</em> <code>cd_values[]</code> + <dd>IN: Auxiliary data for the filter. + </dl> + <dt><strong>Returns:</strong> + <dd>Returns SUCCEED (0) if successful; + otherwise FAIL (-1). +</dl> + + +<hr> +<dl> + <dt><strong>Name:</strong> <a name="Property-GetNFilters">H5Pget_nfilters</a> + <dt><strong>Signature:</strong> + <dd><em>int</em> <code>H5Pget_nfilters</code>(<em>hid_t</em> <code>plist</code>) + <dt><strong>Purpose:</strong> + <dd>Returns the number of filters in the pipeline. + <dt><strong>Description:</strong> + <dd><code>H5Pget_nfilters</code> returns the number of filters + defined in the filter pipeline associated with the property list + <code>plist</code>. + <p> + In each pipeline, the filters are numbered from + 0 through <em>N</em>-1, where <em>N</em> is the value returned + by this function. During output to the file, the filters are + applied in increasing order; during input from the file, they + are applied in decreasing order. + <p> + <code>H5Pget_nfilters</code> returns the number of filters + in the pipeline, including zero (<code>0</code>) if there + are none. + <dt><strong>Note:</strong> + <dd>This function currently supports only the permanent filter + pipeline; <code>plist_id</code> must be a dataset creation + property list. + <dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>plist</code> + <dd>IN: Property list identifier. + </dl> + <dt><strong>Returns:</strong> + <dd>Returns the number of filters in the pipeline if successful; + otherwise returns FAIL (-1). +</dl> + + +<hr> +<dl> + <dt><strong>Name:</strong> <a name="Property-GetFilter">H5Pget_filter</a> + <dt><strong>Signature:</strong> + <dd><em>H5Z_filter_t</em> <code>H5Pget_filter</code>(<em>hid_t</em> <code>plist</code>, + <em>int</em> <code>filter_number</code>, + <em>unsigned int *</em><code>flags</code>, + <em>size_t *</em><code>cd_nelmts</code>, + <em>unsigned int *</em><code>cd_values</code>, + <em>size_t</em> <code>namelen</code>, + <em>char</em> <code>name[]</code> + ) + <dt><strong>Purpose:</strong> + <dd>Returns information about a filter in a pipeline. + <dt><strong>Description:</strong> + <dd><code> </code> + <code>H5Pget_filter</code> returns information about a + filter, specified by its filter number, in a filter pipeline, + specified by the property list with which it is associated. + <p> + If <code>plist</code> is a dataset creation property list, + the pipeline is a permanent filter pipeline; + if <code>plist</code> is a dataset transfer property list, + the pipeline is a transient filter pipeline. + <p> + On input, <code>cd_nelmts</code> indicates the number of entries + in the <code>cd_values</code> array, as allocated by the caller; + on return,<code>cd_nelmts</code> contains the number of values + defined by the filter. + <p> + <code>filter_number</code> is a value between zero and + <em>N</em>-1, as described in + <a href="#Property-GetNFilters"><code>H5Pget_nfilters()</code></a>. + The function will return FAIL (-1) if the filter number is out + of range. + <p> + If <code>name</code> is a pointer to an array of at least + <code>namelen</code> bytes, the filter name will be copied + into that array. The name will be null terminated if + <code>namelen</code> is large enough. The filter name returned + will be the name appearing in the file, the name registered + for the filter, or an empty string. + <p> + The structure of the <code>flags</code> argument is discussed + in <a href="#Property-SetFilter"><code>H5Pset_filter()</code></a>. + <dt><strong>Note:</strong> + <dd>This function currently supports only the permanent filter + pipeline; <code>plist</code> must be a dataset creation property + list. + <dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>plist</code> + <dd>IN: Property list identifier. + <dt><em>int</em> <code>filter_number</code> + <dd>IN: Sequence number within the filter pipeline of + the filter for which information is sought. + <dt><em>unsigned int *</em><code>flags</code> + <dd>OUT: Bit vector specifying certain general properties + of the filter. + <dt><em>size_t *</em><code>cd_nelmts</code> + <dd>IN/OUT: Number of elements in <code>cd_values</code> + <dt><em>unsigned int *</em><code>cd_values</code> + <dd>OUT: Auxiliary data for the filter. + <dt><em>size_t</em> <code>namelen</code> + <dd>IN: Anticipated number of characters in <code>name</code>. + <dt><em>char</em> <code>name[]</code> + <dd>OUT: Name of the filter. + </dl> + <dt><strong>Returns:</strong> + <dd>Returns the filter identification number if successful. + Otherwise returns H5Z_FILTER_ERROR (-1). +</dl> + + +<hr> +<dl> <dt><strong>Name:</strong> <a name="Property-GetDriver">H5Pget_driver</a> <dt><strong>Signature:</strong> <dd><em>H5F_driver_t</em> <code>H5Pget_driver</code>(<em>hid_t</em> <code>plist</code>, @@ -1015,9 +1210,8 @@ many different parameters to be easily manipulated. in the stdio.h. <dt><strong>Description:</strong> <dd><code>H5Pset_stdio</code> sets the low level file driver to use - the functions declared - in the stdio.h file: fopen(), fseek() or fseek64(), fread(), - fwrite(), and fclose(). + the functions declared in the stdio.h file: fopen(), fseek() + or fseek64(), fread(), fwrite(), and fclose(). <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>plist</code> @@ -1113,13 +1307,14 @@ many different parameters to be easily manipulated. <dt><strong>Purpose:</strong> <dd>Sets the low-level file driver to use malloc() and free(). <dt><strong>Description:</strong> - <dd><code>H5Pset_core</code> sets the low-level file driver to use malloc() and free(). + <dd><code>H5Pset_core</code> sets the low-level file driver to use + <code>malloc()</code> and <code>free()</code>. This driver is restricted to temporary files which are not - larger than the amount of virtual memory available. The - INCREMENT argument determines the file block size and memory - will be allocated in multiples of INCREMENT bytes. A liberal - INCREMENT results in fewer calls to realloc() and probably - less memory fragmentation. + larger than the amount of virtual memory available. + The <code>increment</code> argument determines the file block size + and memory will be allocated in multiples of INCREMENT bytes. + A liberal <code>increment</code> results in fewer calls to + <code>realloc()</code> and probably less memory fragmentation. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>plist</code> @@ -1146,10 +1341,10 @@ many different parameters to be easily manipulated. <dt><strong>Description:</strong> <dd><code>H5Pget_core</code> checks to determine whether the file access property list is set to the core driver. - On success, the block size is returned - through the INCREMENT argument if it isn't the null pointer. + On success, the block size is returned through the + <code>increment</code> if it is not the null pointer. In the future, additional arguments may be added to this - function to match those added to H5Pset_core(). + function to match those added to <code>H5Pset_core()</code>. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>plist</code> @@ -1181,7 +1376,7 @@ many different parameters to be easily manipulated. split meta data from raw data, storing meta data in one file and raw data in another file. The meta file will have a name which is formed by adding <em>meta_extension</em> (recommended - default value: <code>.meta</code>) to the end of the base name + default value: <code>.meta</code>) to the end of the base name and will be accessed according to the <em>meta_properties</em>. The raw file will have a name which is formed by appending <em>raw_extension</em> (recommended default value: @@ -1228,15 +1423,15 @@ many different parameters to be easily manipulated. <dd><code>H5Pget_split</code> checks to determine whether the file access property list is set to the split driver. On successful return, - <em>meta_properties</em> and <em>raw_properties</em> will + <code>meta_properties</code> and <code>raw_properties</code> will point to copies of the meta and raw access property lists which should be closed by calling <code>H5Pclose()</code> when the application is finished with them, but if the meta and/or raw file has no property list then a negative value is returned for that property list identifier. Also, if - <em>meta_extension</em> and/or <em>raw_extension</em> are - non-null pointers, at most <em>meta_ext_size</em> or - <em>raw_ext_size</em> characters of the meta or raw file name + <code>meta_extension</code> and/or <code>raw_extension</code> are + non-null pointers, at most <code>meta_ext_size</code> or + <code>raw_ext_size</code> characters of the meta or raw file name extension will be copied to the specified buffer. If the actual name is longer than what was requested then the result will not be null terminated (similar to @@ -1281,6 +1476,7 @@ many different parameters to be easily manipulated. <dd>Sets the file access properties list to the <em>family</em> driver. <dt><strong>Description:</strong> + <dd><i>Original version. Edited version below.</i> <dd><code>H5Pset_family</code> sets the file access properties to use the <em>family</em> driver; any previously defined driver properties are erased @@ -1315,6 +1511,60 @@ many different parameters to be easily manipulated. <hr> <dl> + <dt><strong>Name:</strong> <a name="Property-SetFamily">H5Pset_family</a> + <dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Pset_family</code>(<em>hid_t</em> <code>plist</code>, + <em>hsize_t</em> <code>memb_size</code>, + <em>hid_t</em> <code>memb_plist</code> + ) + <dt><strong>Purpose:</strong> + <dd>Sets the file access properties list to the <code>family</code> + driver. + <dt><strong>Description:</strong> + <dd><i>Edited version. Original version above.</i> + <dd><code>H5Pset_family</code> sets the file access properties + to use the <code>family</code> driver; any previously defined + driver properties are erased from the property list. + See <a href="Files.html#File_Families">File Families</a> + in the <cite>HDF5 User's Guide</dite> for a discussion + of file families. + <p> + Each member of the file family will use <code>memb_plist</code> + as its file access property list. + <p> + The <code>memb_size</code> argument gives the logical size + in bytes of each family member; the actual size could be + smaller depending on whether the file contains holes. + The member size is only used when creating a new file or + truncating an existing file; otherwise the member size comes + from the size of the first member of the family being + opened. + <p> + Note: If the size of the <code>off_t</code> type is + four bytes, then the maximum family member size is usually + 2^31-1 because the byte at offset 2,147,483,647 is generally + inaccessable. + <p> + Additional parameters may be added to this function in the + future. + <dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>plist</code> + <dd>IN: Identifier of the file access property list. + <dt><em>hsize_t</em> <code>memb_size</code> + <dd>IN: Logical size, in bytes, of each family member. + <dt><em>hid_t</em> <code>memb_plist</code> + <dd>IN: Identifier of the file access property list + for each member of the family. + </dl> + <dt><strong>Returns:</strong> + <dd>Returns SUCCEED (0) if successful; + otherwise FAIL (-1). +</dl> + + +<hr> +<dl> <dt><strong>Name:</strong> <a name="Property-GetFamily">H5Pget_family</a> <dt><strong>Signature:</strong> <dd><em>herr_t</em> <code>H5Pget_family</code>(<em>hid_t</em> <code>tid</code>, @@ -1365,8 +1615,9 @@ many different parameters to be easily manipulated. <dd>Sets the number of elements in the meta data cache and the total number of bytes in the raw data chunk cache. <dt><strong>Description:</strong> - <dd><code>H5Pset_cache</code> sets the number of elements (objects) in the meta data cache and the - total number of bytes in the raw data chunk cache. + <dd><code>H5Pset_cache</code> sets the number of elements (objects) + in the meta data cache and the total number of bytes in the + raw data chunk cache. <p> Sets or queries the meta data cache and raw data chunk cache parameters. The <em>plist</em> is a file access property @@ -1458,8 +1709,8 @@ many different parameters to be easily manipulated. hyperslab of a simple data space the buffer must be large enough to hold a 1x200x300 slab. <p> - If TCONV and/or BKG are null pointers then buffers will be - allocated and freed during the data transfer. + If <code>tconv</code> and/or <code>bkg</code> are null pointers, + then buffers will be allocated and freed during the data transfer. <p> The default value for the maximum buffer is 1 Mb. <dt><strong>Parameters:</strong> @@ -1562,6 +1813,8 @@ many different parameters to be easily manipulated. </dl> +<!-- + <hr> <dl> <dt><strong>Name:</strong> <a name="Property-SetCompression">H5Pset_compression</a> @@ -1575,8 +1828,9 @@ many different parameters to be easily manipulated. <dt><strong>Purpose:</strong> <dd>Sets compression method. <dt><strong>Description:</strong> - <dd> <code>H5Pset_compression</code> sets the compression method in a dataset creation property - list. This is a catch-all function for defining compresion methods + <dd><code>H5Pset_compression</code> sets the compression method + in a dataset creation property list. This is a catch-all + function for defining compresion methods and is intended to be called from a wrapper such as <code>H5Pset_deflate()</code>. The dataset creation property list <em>plist</em> is adjusted to use the specified @@ -1586,13 +1840,13 @@ many different parameters to be easily manipulated. <em>client_data</em> is a byte array of length <em>cd_size</em> which is copied to the file and passed to the compress and uncompress methods. - <p> - The FLAGS, CD_SIZE, and CLIENT_DATA are copied to the - property list and eventually to the file and passed to the - compression functions. - <p> - See <a href="Compression.html"><cite>Compression</cite></a> - in the <cite>HDF5 User's Guide</cite> for further information. + <p> + The FLAGS, CD_SIZE, and CLIENT_DATA are copied to the + property list and eventually to the file and passed to the + compression functions. + <p> + See <a href="Compression.html"><cite>Compression</cite></a> + in the <cite>HDF5 User's Guide</cite> for further information. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>plist</code> @@ -1611,6 +1865,10 @@ many different parameters to be easily manipulated. otherwise FAIL (-1). </dl> +--> + + +<!-- <hr> <dl> @@ -1626,11 +1884,12 @@ many different parameters to be easily manipulated. <dt><strong>Description:</strong> <dd><code>H5Pget_compression</code> gets the compression method information from a dataset creation property list. - The CLIENT_DATA buffer is initially CD_SIZE bytes. - On return, CLIENT_DATA will be initialized - with at most that many bytes, and CD_SIZE will contain the - actual size of the client data, which might be larger than - its original value.<dt><strong>Parameters:</strong> + The <code>client_data</code> buffer is initially + <code>cd_size</code> bytes. On return, <code>client_data</code> + will be initialized with at most that many bytes, and + <code>cd_size</code> will contain the actual size of the + client data, which might be larger than its original value. + <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>plist</code> <dd>IN: Identifier for the dataset creation property list. @@ -1646,6 +1905,8 @@ many different parameters to be easily manipulated. otherwise FAIL (-1). </dl> +--> + <hr> <dl> @@ -1658,12 +1919,11 @@ many different parameters to be easily manipulated. <dd>Sets compression method and compression level. <dt><strong>Description:</strong> <dd><code>H5Pset_deflate</code> sets the compression method for a - dataset creation property - list to H5D_COMPRESS_DEFLATE and the compression level to - LEVEL which should be a value between zero and nine, - inclusive. Lower compression levels are faster but result in - less compression. This is the same algorithm as used by the - GNU gzip program. + dataset creation property list to <code>H5D_COMPRESS_DEFLATE</code> + and the compression level to <code>level<>/code>, which should + be a value from zero to nine, inclusive. + Lower compression levels are faster but result in less compression. + This is the same algorithm as used by the GNU gzip program. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>plist</code> @@ -1677,6 +1937,8 @@ many different parameters to be easily manipulated. </dl> +<!-- + <hr> <dl> <dt><strong>Name:</strong> <a name="Property-GetDeflate">H5Pget_deflate</a> @@ -1699,6 +1961,8 @@ many different parameters to be easily manipulated. Otherwise returns FAIL (-1). </dl> +--> + <hr> <center> @@ -1713,15 +1977,20 @@ H5P <a href="RM_H5S.html">H5S</a> <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> +<a href="Tools.html">Tools</a> +<!-- <a href="Glossary.html">Glossary</a> +--> </center> <hr> + <address> <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 14 July 1998 +Last modified: 25 August 1998 </body> </html> + diff --git a/doc/html/RM_H5R.html b/doc/html/RM_H5R.html new file mode 100644 index 0000000..4e1fd7c --- /dev/null +++ b/doc/html/RM_H5R.html @@ -0,0 +1,248 @@ +<html> +<head><title> +HDF5/H5R Draft API Specification +</title></head> + +<body> + +<hr> +<center> +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<a href="RM_H5.html">H5</a> +<a href="RM_H5A.html">H5A</a> +<a href="RM_H5D.html">H5D</a> +<a href="RM_H5E.html">H5E</a> +<a href="RM_H5F.html">H5F</a> +<a href="RM_H5G.html">H5G</a> +<a href="RM_H5P.html">H5P</a> +H5R +<a href="RM_H5S.html">H5S</a> +<a href="RM_H5T.html">H5T</a> +<a href="RM_H5Z.html">H5Z</a> +<a href="Tools.html">Tools</a> +<!-- +<a href="Glossary.html">Glossary</a> +--> +</center> +<hr> + +<center> +<h1>H5R: Ragged Array Interface</h1> +</center> + +<h2>Ragged Array API Functions</h2> +<table border=1> +<tr><th align=left> +<font color=red> +The H5R Interface is strictly experimental at this time; +the interface may change dramatically or support for ragged arrays +may be unavailable in future in releases. As a result, future releases +may be unable to retrieve data stored with this interface. +<p><center>Use these functions at your own risk!<br> +Do not create any archives using this interface!</center> +</font> +</th></tr> +</table> +<p> +These functions enable the user to store and retrieve data in ragged arrays. + + +<table border=0> +<tr><td valign=top> +<ul> + <li><a href="#Ragged-Create">H5Rcreate</a> + <li><a href="#Ragged-Open">H5Ropen</a> + <li><a href="#Ragged-Close">H5Rclose</a> +</ul> +</td><td> </td><td valign=top> +<ul> + <li><a href="#Ragged-Write">H5Rwrite</a> + <li><a href="#Ragged-Read">H5Rread</a> +</ul> +</td></tr> +</table> + +<p> + + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Ragged-Create">H5Rcreate</a> +<dt><strong>Signature:</strong> + <dd><em> </em> <code>H5Rcreate</code>(<em> </em> <code> </code>, + <em> </em> <code> </code>, + <em> </em> <code> </code> + ) +<dt><strong>Purpose:</strong> + <dd> +<dt><strong>Description:</strong> + <dd><code>H5Rcreate</code> +<dt><strong>Parameters:</strong> + <dl> + <dt><em> </em> <code> </code> + <dd> + <dt><em> </em> <code> </code> + <dd> + <dt><em> </em> <code> </code> + <dd> + </dl> +<dt><strong>Returns:</strong> + <dd>Returns SUCCEED (0) if successful; + otherwise FAIL (-1). +</dl> + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Ragged-Open">H5Ropen</a> +<dt><strong>Signature:</strong> + <dd><em> </em> <code>H5Ropen</code>(<em> </em> <code> </code>, + <em> </em> <code> </code>, + <em> </em> <code> </code> + ) +<dt><strong>Purpose:</strong> + <dd> +<dt><strong>Description:</strong> + <dd><code>H5Ropen</code> +<dt><strong>Parameters:</strong> + <dl> + <dt><em> </em> <code> </code> + <dd> + <dt><em> </em> <code> </code> + <dd> + <dt><em> </em> <code> </code> + <dd> + </dl> +<dt><strong>Returns:</strong> + <dd>Returns SUCCEED (0) if successful; + otherwise FAIL (-1). +</dl> + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Ragged-Close">H5Rclose</a> +<dt><strong>Signature:</strong> + <dd><em> </em> <code>H5Rclose</code>(<em> </em> <code> </code>, + <em> </em> <code> </code>, + <em> </em> <code> </code> + ) +<dt><strong>Purpose:</strong> + <dd> +<dt><strong>Description:</strong> + <dd><code>H5Rclose</code> +<dt><strong>Parameters:</strong> + <dl> + <dt><em> </em> <code> </code> + <dd> + <dt><em> </em> <code> </code> + <dd> + <dt><em> </em> <code> </code> + <dd> + </dl> +<dt><strong>Returns:</strong> + <dd>Returns SUCCEED (0) if successful; + otherwise FAIL (-1). +</dl> + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Ragged-Write">H5Rwrite</a> +<dt><strong>Signature:</strong> + <dd><em> </em> <code>H5Rwrite</code>(<em> </em> <code> </code>, + <em> </em> <code> </code>, + <em> </em> <code> </code> + ) +<dt><strong>Purpose:</strong> + <dd> +<dt><strong>Description:</strong> + <dd><code>H5Rwrite</code> + <p> + Datatype conversion takes place at the time of a read or write + and is automatic. See the + <a href="Datatypes.html#Datatypes-DataConversion">Data Conversion</a> + section of <cite>The Data Type Interface (H5T)</cite> in the + <cite>HDF5 User's Guide</cite> for a discussion of + data conversion, including the range of conversions currently + supported by the HDF5 libraries. +<dt><strong>Parameters:</strong> + <dl> + <dt><em> </em> <code> </code> + <dd> + <dt><em> </em> <code> </code> + <dd> + <dt><em> </em> <code> </code> + <dd> + </dl> +<dt><strong>Returns:</strong> + <dd>Returns SUCCEED (0) if successful; + otherwise FAIL (-1). +</dl> + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Ragged-Read">H5Rread</a> +<dt><strong>Signature:</strong> + <dd><em> </em> <code>H5Rread</code>(<em> </em> <code> </code>, + <em> </em> <code> </code>, + <em> </em> <code> </code> + ) +<dt><strong>Purpose:</strong> + <dd> +<dt><strong>Description:</strong> + <dd><code>H5Rread</code> + <p> + Datatype conversion takes place at the time of a read or write + and is automatic. See the + <a href="Datatypes.html#Datatypes-DataConversion">Data Conversion</a> + section of <cite>The Data Type Interface (H5T)</cite> in the + <cite>HDF5 User's Guide</cite> for a discussion of + data conversion, including the range of conversions currently + supported by the HDF5 libraries. +<dt><strong>Parameters:</strong> + <dl> + <dt><em> </em> <code> </code> + <dd> + <dt><em> </em> <code> </code> + <dd> + <dt><em> </em> <code> </code> + <dd> + </dl> +<dt><strong>Returns:</strong> + <dd>Returns SUCCEED (0) if successful; + otherwise FAIL (-1). +</dl> + + +<hr> +<center> +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<a href="RM_H5.html">H5</a> +<a href="RM_H5A.html">H5A</a> +<a href="RM_H5D.html">H5D</a> +<a href="RM_H5E.html">H5E</a> +<a href="RM_H5F.html">H5F</a> +<a href="RM_H5G.html">H5G</a> +<a href="RM_H5P.html">H5P</a> +H5R +<a href="RM_H5S.html">H5S</a> +<a href="RM_H5T.html">H5T</a> +<a href="RM_H5Z.html">H5Z</a> +<a href="Tools.html">Tools</a> +<!-- +<a href="Glossary.html">Glossary</a> +--> +</center> +<hr> + +<address> +<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> + +<br> +Last modified: 1 September 1998 + +</body> +</html> diff --git a/doc/html/RM_H5S.html b/doc/html/RM_H5S.html index 6230e56..64fd250 100644 --- a/doc/html/RM_H5S.html +++ b/doc/html/RM_H5S.html @@ -18,7 +18,10 @@ HDF5/H5S Draft API Specification H5S <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> +<a href="Tools.html">Tools</a> +<!-- <a href="Glossary.html">Glossary</a> +--> </center> <hr> @@ -36,27 +39,62 @@ elements of a dataset. <ul> <li><a href="#Dataspace-Create">H5Screate</a> <li><a href="#Dataspace-CreateSimple">H5Screate_simple</a> + <li><a href="#Dataspace-IsSimple">H5Sis_simple</a> + <li><a href="#Dataspace-OffsetSimple">H5Soffset_simple</a> <li><a href="#Dataspace-Copy">H5Scopy</a> - <li><a href="#Dataspace-SelectNpoints">H5Sselect_npoints</a> - <li><a href="#Dataspace-SelectElements">H5Sselect_elements</a> + <li><a href="#Dataspace-ExtentClass">H5Sextent_class</a> + <li><a href="#Dataspace-ExtentCopy">H5Sextent_copy</a> </ul> </td><td> </td><td valign=top> <ul> - <li><a href="#Dataspace-ExtentNpoints">H5Sextent_npoints</a> - <li><a href="#Dataspace-ExtentNdims">H5Sextent_ndims</a> - <li><a href="#Dataspace-ExtentDims">H5Sextent_dims</a> - <li><a href="#Dataspace-GetClass">H5Sget_class</a> + <li><a href="#Dataspace-SetExtentSimple">H5Sset_extent_simple</a> + <li><a href="#Dataspace-SetExtentNone">H5Sset_extent_none</a> + <li><a href="#Dataspace-SelectNpoints">H5Sget_select_npoints</a> + <li><a href="#Dataspace-ExtentDims">H5Sget_simple_extent_dims</a> + <li><a href="#Dataspace-ExtentNdims">H5Sget_simple_extent_ndims</a> + <li><a href="#Dataspace-ExtentNpoints">H5Sget_simple_extent_npoints</a> + <li><a href="#Dataspace-GetSpaceType">H5Sget_space_type</a> </ul> </td><td> </td><td valign=top> <ul> - <li><a href="#Dataspace-SetExtentSimple">H5Sset_extent_simple</a> - <li><a href="#Dataspace-IsSimple">H5Sis_simple</a> + <li><a href="#Dataspace-SelectElements">H5Sselect_elements</a> + <li><a href="#Dataspace-SelectAll">H5Sselect_all</a> + <li><a href="#Dataspace-SelectNone">H5Sselect_none</a> + <li><a href="#Dataspace-SelectValid">H5Sselect_valid</a> <li><a href="#Dataspace-SelectHyperslab">H5Sselect_hyperslab</a> <li><a href="#Dataspace-Close">H5Sclose</a> </ul> </td></tr> </table> +<p> +The following H5S functions are included in the HDF5 specification, +but have not yet been implemented. They are described in the +<a href="Datatypes.html">The Data Type Interface (H5T)</a> section +of the <cite>HDF5 User's Guide.</cite>. +<table border=0> +<tr><td valign=top> +<ul> + <li>H5Scommit + <li>H5Sis_subspace + <li>H5Slock + <li>H5Sopen +</ul> +</td><td> </td><td valign=top> +<ul> + <li>H5Sselect_name + <li>H5Sselect_op + <li>H5Sselect_order +</ul> +</td><td> </td><td valign=top> +<ul> + <li>H5Ssubspace + <li>H5Ssubspace_name + <li>H5Ssubspace_location +</ul> +</td></tr> +</table> + <hr> <dl> @@ -196,18 +234,89 @@ elements of a dataset. </dl> +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Dataspace-SelectAll">H5Sselect_all</a> +<dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Sselect_all</code>(<em>hid_t</em> <code>space_id</code>) +<dt><strong>Purpose:</strong> + <dd>Selects the entire dataspace. +<dt><strong>Description:</strong> + <dd><code>H5Sselect_all</code> selects the entire extent + of the dataspace <code>space_id</code>. + <p> + More specifically, <code>H5Sselect_all</code> selects + the special <tt>5S_SELECT_ALL</tt> region for the dataspace + <code>space_id</code>. <tt>H5S_SELECT_ALL</tt> selects the + entire dataspace for any dataspace it is applied to. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>space_id</code> + <dd>IN: The identifier for the dataspace in which the + selection is being made. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns SUCCEED (0) if successful; + otherwise FAIL (-1). +</dl> + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Dataspace-SelectNone">H5Sselect_none</a> +<dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Sselect_none</code>(<em>hid_t</em> <code>space_id</code>) +<dt><strong>Purpose:</strong> + <dd>Resets the selection region to include no elements. +<dt><strong>Description:</strong> + <dd><code>H5Sselect_none</code> resets the selection region + for the dataspace <code>space_id</code> to include no elements. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>space_id</code> + <dd>IN: The identifier for the dataspace in which the + selection is being reset. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns SUCCEED (0) if successful; + otherwise FAIL (-1). +</dl> +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Dataspace-SelectValid">H5Sselect_valid</a> +<dt><strong>Signature:</strong> + <dd><em>hbool_t</em> <code>H5Sselect_valid</code>(<em>hid_t</em> <code>space_id</code>) +<dt><strong>Purpose:</strong> + <dd>Verifies that the selection is within the extent of the dataspace. +<dt><strong>Description:</strong> + <dd><code>H5Sselect_valid</code> verifies that the selection + for the dataspace <code>space_id</code> is within the extent + of the dataspace if the current offset for the dataspace is used. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>space_id</code> + <dd>The identifier for the dataspace in which the + selection is being reset. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns <tt>TRUE</tt> if the selection is contained within + the extent and <tt>FALSE</tt> if it is not. + Returns <tt>FAIL</tt> (<tt>-1</tt>) on error conditions + such as the selection or extent not being defined. +</dl> + <hr> <dl> -<dt><strong>Name:</strong> <a name="Dataspace-ExtentNpoints">H5Sextent_npoints</a> +<dt><strong>Name:</strong> <a name="Dataspace-ExtentNpoints">H5Sget_simple_extent_npoints</a> <dt><strong>Signature:</strong> - <dd><em>hsize_t</em> <code>H5Sextent_npoints</code>(<em>hid_t </em><code>space_id</code>) + <dd><em>hsize_t</em> <code>H5Sget_simple_extent_npoints</code>(<em>hid_t </em><code>space_id</code>) <dt><strong>Purpose:</strong> <dd>Determines the number of elements in a dataspace. <dt><strong>Description:</strong> - <dd><code>H5Sextent_npoints</code> determines the number of elements + <dd><code>H5Sget_simple_extent_npoints</code> determines the number of elements in a dataspace. For example, a simple 3-dimensional dataspace with dimensions 2, 3, and 4 would have 24 elements. <dt><strong>Parameters:</strong> @@ -223,13 +332,13 @@ elements of a dataset. <hr> <dl> -<dt><strong>Name:</strong> <a name="Dataspace-SelectNpoints">H5Sselect_npoints</a> +<dt><strong>Name:</strong> <a name="Dataspace-SelectNpoints">H5Sget_select_npoints</a> <dt><strong>Signature:</strong> - <dd><em>hsize_t</em> <code>H5Sselect_npoints</code>(<em>hid_t</em> <code>space_id</code>) + <dd><em>hsize_t</em> <code>H5Sget_select_npoints</code>(<em>hid_t</em> <code>space_id</code>) <dt><strong>Purpose:</strong> <dd>Determines the number of elements in a dataspace. <dt><strong>Description:</strong> - <dd><code>H5Sselect_npoints</code> determines the number of elements + <dd><code>H5Sget_select_npoints</code> determines the number of elements in the current selection of a dataspace. <dt><strong>Parameters:</strong> <dl> @@ -237,20 +346,20 @@ elements of a dataset. <dd>Dataspace identifier. </dl> <dt><strong>Returns:</strong> - <dd>Returns a dataspace identifier if successful; + <dd>Returns the number of elements in the selection if successful; otherwise FAIL (-1). </dl> <hr> <dl> -<dt><strong>Name:</strong> <a name="Dataspace-ExtentNdims">H5Sextent_ndims</a> +<dt><strong>Name:</strong> <a name="Dataspace-ExtentNdims">H5Sget_simple_extent_ndims</a> <dt><strong>Signature:</strong> - <dd><em>int</em> <code>H5Sextent_ndims</code>(<em>hid_t</em> <code>space_id</code>) + <dd><em>int</em> <code>H5Sget_simple_extent_ndims</code>(<em>hid_t</em> <code>space_id</code>) <dt><strong>Purpose:</strong> <dd>Determines the dimensionality of a dataspace. <dt><strong>Description:</strong> - <dd><code>H5Sextent_ndims</code> determines the dimensionality (or rank) + <dd><code>H5Sget_simple_extent_ndims</code> determines the dimensionality (or rank) of a dataspace. <dt><strong>Parameters:</strong> <dl> @@ -265,16 +374,16 @@ elements of a dataset. <hr> <dl> -<dt><strong>Name:</strong> <a name="Dataspace-ExtentDims">H5Sextent_dims</a> +<dt><strong>Name:</strong> <a name="Dataspace-ExtentDims">H5Sget_simple_extent_dims</a> <dt><strong>Signature:</strong> - <dd><em>int</em> <code>H5Sextent_dims</code>(<em>hid_t</em> <code>space_id</code>, + <dd><em>int</em> <code>H5Sget_simple_extent_dims</code>(<em>hid_t</em> <code>space_id</code>, <em>hsize_t *</em><code>dims</code>, <em>hsize_t *</em><code>maxdims</code> ) <dt><strong>Purpose:</strong> <dd>Retrieves dataspace dimension size and maximum size. <dt><strong>Description:</strong> - <dd><code>H5Sextent_dims</code> returns the size and maximum sizes + <dd><code>H5Sget_simple_extent_dims</code> returns the size and maximum sizes of each dimension of a dataspace through the <code>dims</code> and <code>maxdims</code> parameters. <dt><strong>Parameters:</strong> @@ -294,9 +403,35 @@ elements of a dataset. <hr> <dl> +<dt><strong>Name:</strong> <a name="Dataspace-GetSpaceType">H5Sget_space_type</a> +<dt><strong>Signature:</strong> + <dd><em>H5S_class_t</em> <code>H5Sget_space_type</code>(<em>hid_t</em> <code>space_id</code>) +<dt><strong>Purpose:</strong> + <dd>Determine the current class of a dataspace. +<dt><strong>Description:</strong> + <dd><code>H5Sget_space_type</code> queries a dataspace to determine the + current class of a dataspace. + <p> + The function returns a class name, one of the following: + <code>H5S_SCALAR</code>, + <code>H5S_SIMPLE</code>, or + <code>H5S_NONE</code>. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>space_id</code> + <dd>Dataspace identifier. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns a dataspace class name if successful; + otherwise FAIL (-1). +</dl> + + +<hr> +<dl> <dt><strong>Name:</strong> <a name="Dataspace-SetExtentSimple">H5Sset_extent_simple</a> <dt><strong>Signature:</strong> - <dd><em>herr_t</em> <code>H5S_set_extent_simple</code>(<em>hid_t</em> <code>space_id</code>, + <dd><em>herr_t</em> <code>H5Sset_extent_simple</code>(<em>hid_t</em> <code>space_id</code>, <em>int</em> <code>rank</code>, <em>const hsize_t *</em><code>current_size</code>, <em>const hsize_t *</em><code>maximum_size</code> @@ -304,7 +439,7 @@ elements of a dataset. <dt><strong>Purpose:</strong> <dd>Sets or resets the size of an existing dataspace. <dt><strong>Description:</strong> - <dd><code>H5S_set_extent_simple</code> sets or resets the size of + <dd><code>H5Sset_extent_simple</code> sets or resets the size of an existing dataspace. <p> <code>rank</code> is the dimensionality, or number of @@ -360,19 +495,51 @@ elements of a dataset. <hr> <dl> -<dt><strong>Name:</strong> <a name="Dataspace-GetClass">H5Sget_class</a> +<dt><strong>Name:</strong> <a name="Dataspace-OffsetSimple">H5Soffset_simple</a> <dt><strong>Signature:</strong> - <dd><em>H5S_class_t</em> <code>H5Sget_class</code>(<em>hid_t</em> <code>space_id</code>) + <dd><em>herr_t</em> <code>H5Soffset_simple</code>(<em>hid_t</em> <code>space_id</code>, + <em>const hssize_t *</em><code>offset</code> + ) +<dt><strong>Purpose:</strong> + <dd>Sets the offset of a simple dataspace. +<dt><strong>Description:</strong> + <dd><code>H5Soffset_simple</code> sets the offset of a + simple dataspace <code>space_id</code>. The <code>offset</code> + array must be the same number of elements as the number of + dimensions for the dataspace. If the <code>offset</code> + array is set to <TT>NULL</TT>, the offset for the dataspace + is reset to 0. + <p> + This function allows the same shaped selection to be moved + to different locations within a dataspace without requiring it + to be redefined. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>space_id</code> + <dd>IN: The identifier for the dataspace object to reset. + <dt><em>const hssize_t *</em><code>offset</code> + <dd>IN: The offset at which to position the selection. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns SUCCEED (0) if successful; + otherwise FAIL (-1). +</dl> + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Dataspace-ExtentClass">H5Sextent_class</a> +<dt><strong>Signature:</strong> + <dd><em>H5S_class_t</em> <code>H5Sextent_class</code>(<em>hid_t</em> <code>space_id</code>) <dt><strong>Purpose:</strong> <dd>Determine the current class of a dataspace. <dt><strong>Description:</strong> - <dd><code>H5Sget_class</code> queries a dataspace to determine the + <dd><code>H5Sextent_class</code> queries a dataspace to determine the current class of a dataspace. <p> The function returns a class name, one of the following: <code>H5S_SCALAR</code>, - <code>H5S_SIMPLE</code>, or - <code>H5S_NONE</code>. + <code>H5S_SIMPLE</code>. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>space_id</code> @@ -380,6 +547,56 @@ elements of a dataset. </dl> <dt><strong>Returns:</strong> <dd>Returns a dataspace class name if successful; + otherwise H5S_NO_CLASS (-1). +</dl> + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Dataspace-ExtentCopy">H5Sextent_copy</a> +<dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Sextent_copy</code>(<em>hid_t</em> <code>dest_space_id</code>, + <em>hid_t</em> <code>source_space_id</code> + ) +<dt><strong>Purpose:</strong> + <dd>Copies the extent of a dataspace. +<dt><strong>Description:</strong> + <dd><code>H5Sextent_copy</code> copies the extent from + <code>source_space_id</code> to <code>dest_space_id</code>. + This action may change the type of the dataspace. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>dest_space_id</code> + <dd>IN: The identifier for the dataspace from which + the extent is copied. + <dt><em>hid_t</em> <code>source_space_id</code> + <dd>IN: The identifier for the dataspace to which + the extent is copied. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns SUCCEED (0) if successful; + otherwise FAIL (-1). +</dl> + + +<hr> +<dl> +<dt><strong>Name:</strong> <a name="Dataspace-SetExtentNone">H5Sset_extent_none</a> +<dt><strong>Signature:</strong> + <dd><em>herr_t</em> <code>H5Sset_extent_none</code>(<em>hid_t</em> <code>space_id</code>) +<dt><strong>Purpose:</strong> + <dd>Removes the extent from a dataspace. +<dt><strong>Description:</strong> + <dd><code>H5Sset_extent_none</code> removes the extent from + a dataspace and sets the type to <tt>H5S_NONE</tt>. +<dt><strong>Parameters:</strong> + <dl> + <dt><em>hid_t</em> <code>space_id</code> + <dd>The identifier for the dataspace from which + the extent is to be removed. + </dl> +<dt><strong>Returns:</strong> + <dd>Returns SUCCEED (0) if successful; otherwise FAIL (-1). </dl> @@ -515,7 +732,10 @@ I/O is performed. H5S <a href="RM_H5T.html">H5T</a> <a href="RM_H5Z.html">H5Z</a> +<a href="Tools.html">Tools</a> +<!-- <a href="Glossary.html">Glossary</a> +--> </center> <hr> @@ -523,7 +743,7 @@ H5S <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 14 July 1998 +Last modified: 1 September 1998 </body> </html> diff --git a/doc/html/RM_H5T.html b/doc/html/RM_H5T.html index 0fa5926..086b9cc 100644 --- a/doc/html/RM_H5T.html +++ b/doc/html/RM_H5T.html @@ -18,7 +18,10 @@ HDF5/H5T Draft API Specification <a href="RM_H5S.html">H5S</a> H5T <a href="RM_H5Z.html">H5Z</a> +<a href="Tools.html">Tools</a> +<!-- <a href="Glossary.html">Glossary</a> +--> </center> <hr> @@ -121,7 +124,7 @@ A <em>data point</em> is an instance of a <em>datatype</em>, <p> See <a href="Datatypes.html"><cite>The Datatype Interface (H5T)</cite></a> -in the <cite>HDF5 User's Guide</cite> for further information. +in the <cite>HDF5 User's Guide</cite> for further information, including a complete list of all supported datatypes. <hr> @@ -142,7 +145,7 @@ in the <cite>HDF5 User's Guide</cite> for further information. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>loc_id</code> - <dd>A file or group identifier. + <dd>A file, group, or datatype identifier. <dt><em>const char *</em> <code>name</code> <dd>A datatype name. </dl> @@ -489,6 +492,14 @@ H5Tget_overflow () <dd> Native single-precision float type, declare dataset array as 'float' <dt>H5T_NATIVE_DOUBLE <dd> Native double-precision float type, declare dataset array as 'double' + <dt>H5T_NATIVE_HSIZE + <dd> Native size_t type, declare dataset array as 'hsize_t' + <dt>H5T_NATIVE_HSSIZE + <dd> Native signed size_t type, declare dataset array as 'hssize_t' + <dt>H5T_NATIVE_HERR + <dd> Native error type, declare dataset array as 'herr_t' + <dt>H5T_NATIVE_HBOOL + <dd> Native boolean type, declare dataset array as 'hbool_t' </dl> </ul> --> <dt><strong>Parameters:</strong> @@ -1741,7 +1752,10 @@ zero. <a href="RM_H5S.html">H5S</a> H5T <a href="RM_H5Z.html">H5Z</a> +<a href="Tools.html">Tools</a> +<!-- <a href="Glossary.html">Glossary</a> +--> </center> <hr> @@ -1749,7 +1763,7 @@ H5T <a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> <br> -Last modified: 14 July 1998 +Last modified: 2 September 1998 </body> </html> diff --git a/doc/html/RM_H5Z.html b/doc/html/RM_H5Z.html index dbaed4c..5cdc5c8 100644 --- a/doc/html/RM_H5Z.html +++ b/doc/html/RM_H5Z.html @@ -18,7 +18,10 @@ HDF5/H5Z Draft API Specification <a href="RM_H5S.html">H5S</a> <a href="RM_H5T.html">H5T</a> H5Z +<a href="Tools.html">Tools</a> +<!-- <a href="Glossary.html">Glossary</a> +--> </center> <hr> @@ -109,7 +112,10 @@ See <a href="Compression.html"><cite>Compression</cite></a> in the <a href="RM_H5S.html">H5S</a> <a href="RM_H5T.html">H5T</a> H5Z +<a href="Tools.html">Tools</a> +<!-- <a href="Glossary.html">Glossary</a> +--> </center> <hr> diff --git a/doc/html/Tools.html b/doc/html/Tools.html new file mode 100644 index 0000000..b19b57c --- /dev/null +++ b/doc/html/Tools.html @@ -0,0 +1,259 @@ +<html> +<head><title> +HDF5/Tools Draft API Specification +</title></head> + +<body> + +<hr> +<center> +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<a href="RM_H5.html">H5</a> +<a href="RM_H5A.html">H5A</a> +<a href="RM_H5D.html">H5D</a> +<a href="RM_H5E.html">H5E</a> +<a href="RM_H5F.html">H5F</a> +<a href="RM_H5G.html">H5G</a> +<a href="RM_H5P.html">H5P</a> +<!-- +<a href="RM_H5R.html">H5R</a> +--> +<a href="RM_H5S.html">H5S</a> +<a href="RM_H5T.html">H5T</a> +<a href="RM_H5Z.html">H5Z</a> +Tools +<!-- +<a href="Glossary.html">Glossary</a> +--> +</center> +<hr> + +<center> +<h1>HDF5 Tools</h1> +</center> + +<h2>HDF5 Tool Interfaces</h2> +<p> +These tools enable the user to examine HDF5 files interactively. + + +<table border=0> +<tr><td valign=top> +<ul> + <li><a href="#Tools-Dump">h5dump</a> -- A tool for displaying + HDF5 file contents + <li><a href="#Tools-Ls">h5ls</a> -- A tool for listing specified + features of HDF5 file contents + <li><a href="#Tools-Repart">h5repart</a> -- A tool for repartitioning + a file, creating a family of files +</ul> +</td></tr> +</table> + +<p> + + +<hr> +<dl> +<dt><strong>Tool Name:</strong> <a name="Tools-Dump">h5dump</a> +<dt><strong>Syntax:</strong> + <dd><code>h5dump + [-h] + [-bb] + [-header] + [-a </code><em>names</em><code>] + [-d </code><em>names</em><code>] + [-g </code><em>names</em><code>] + [-l </code><em>names</em><code>] </code> + <em>files</em> +<dt><strong>Purpose:</strong> + <dd>Displays HDF5 file contents. +<dt><strong>Description:</strong> + <dd><code>h5dump</code> enables the user to interactively examine + the contents of an HDF5 file and dump those contents, + in human readable form, to an ASCII file or to other tools. + <p> + <code>h5dump</code> displays HDF5 file content on + standard output. It may display the content of the + whole HDF5 file or selected objects, which can be groups, + datasets, links, or attributes. + <p> + The <code>-header</code> option displays object + header information only and must appear before the + <code>-a</code>, <code>-d</code>, <code>-g</code>, or + <code>-l</code> options. + <p> + The <code>h5dump</code> output is described in detail in + <a href="ddl.html">DDL</a>, the <cite>Data Description + Language</cite> document. +<dt><strong>Options and Parameters:</strong> + <dl> + <dt><code>-h</code> + <dd>Print information on this command. + <dt><code>-bb</code> + <dd>Displays the content of boot block. The default is + not to display. + <dt><code>-header</code> + <dd>Displays header information only; no data is displayed. + <dt><code>-a</code> <em>names</em> + <dd>Displays the specified attribute(s). + <dt><code>-d</code> <em>names</em> + <dd>Displays the specified dataset(s). + <dt><code>-g</code> <em>names</em> + <dd>Displays all the objects within the specified group(s). + <dt><code>-l</code> <em>names</em> + <dd>Displays the specified link value(s). + <dt><em>files</em> + <dd>The file(s) to be examined. + </dl> +<dt><strong>Current Status:</strong> + <dd>The current version of <code>h5dump</code> can display the + following types of information: + <ul> + <li>Group name + <li>Attribute name, data type, adata space, and data + <li>Dataset name, data type, data space, and data + <li>Soft link name, link value + </ul> + + <dd>Limitions in the current implementaion include the + following: + <ul> + <li>Only one file is displayed at a time (file families are + not supported). + <li>The whole file content is displayed (none of above + options are supported). + <li>Compound data types are not yet supported. + <li>Complex data spaces are not yet supported. + </ul> +<dt><strong>See Also:</strong> + <dd>HDF5 Data Description Language syntax + (<a href="ddl.html">DDL</a>) +</dl> + + +<hr> +<dl> +<dt><strong>Tool Name:</strong> <a name="Tools-Ls">h5ls</a> +<dt><strong>Syntax:</strong> + <dd><code>h5ls + [</code><em>options</em><code>]</code><em> + file</em><code> + [</code><em>objects...</em><code>]</code> +<dt><strong>Purpose:</strong> + <dd>Prints information about a file or dataset. +<dt><strong>Description:</strong> + <dd><code>h5ls</code> prints selected information about file objects + in the specified format. +<dt><strong>Options and Parameters:</strong> + <dl> + <dt><code>-h</code> or <code>-?</code> or <code>--help</code> + <dd>Print a usage message and exit. + <dt><code>-d</code> or <code>--dump</code> + <dd>Print the values of datasets. + <dt><code>-w</code><em>N</em> or <code>--width=</code><em>N</em> + <dd>Set the number of columns of output. + <dt><code>-v</code> or <code>--verbose</code> + <dd>Generate more verbose output. + <dt><code>-V</code> or <code>--version</code> + <dd>Print version number and exit. + <dt><em>file</em> + <dd>The file name may include a printf(3C) integer format + such as <code>%%05d</code> to open a file family. + <dt><em>objects</em> + <dd>The names of zero or more objects about which information + should be displayed. If a group is mentioned then + information about each of its members is displayed. + If no object names are specified then information about + all of the objects in the root group is displayed. + </dl> +<!-- +<dt><strong>Current Status:</strong> + <dd> +<dt><strong>See Also:</strong> + <dd> +--> +</dl> + + +<hr> +<dl> +<dt><strong>Tool Name:</strong> <a name="Tools-Repart">h5repart</a> +<dt><strong>Syntax:</strong> + <dd><code>h5repart + [-v] + [-V] + [-[b|m]</code><em>N</em><code>[g|m|k]]</code> + <em>source_file + dest_file</em> +<dt><strong>Purpose:</strong> + <dd>Repartitions a file or family of files. +<dt><strong>Description:</strong> + <dd><code>h5repart</code> splits a single file into a family of + files, joins a family of files into a single file, or copies + one family of files to another while changing the size of the + family members. <code>h5repart</code> can also be used to + copy a single file to a single file with holes. + <p> + Sizes associated with the <code>-b</code> and <code>-m</code> + options may be suffixed with <code>g</code> for gigabytes, + <code>m</code> for megabytes, or <code>k</code> for kilobytes. + <p> + File family names include an integer <code>printf</code> + format such as <code>%d</code>. + +<dt><strong>Options and Parameters:</strong> + <dl> + <dt><code>-v</code> + <dd>Produce verbose output. + <dt><code>-V</code> + <dd>Print a version number and exit. + <dt><code>-b</code><em>N</em> + <dd>The I/O block size, defaults to 1kB + <dt><code>-m</code><em>N</em> + <dd>The destination member size or 1GB + <dt><em>source_file</em> + <dd>The name of the source file + <dt><em>dest_file</em> + <dd>The name of the destination files + </dl> +<!-- +<dt><strong>Current Status:</strong> + <dd> +<dt><strong>See Also:</strong> + <dd> +--> +</dl> + + +<hr> +<center> +<a href="RM_H5Front.html">HDF5 Reference Manual</a> +<a href="RM_H5.html">H5</a> +<a href="RM_H5A.html">H5A</a> +<a href="RM_H5D.html">H5D</a> +<a href="RM_H5E.html">H5E</a> +<a href="RM_H5F.html">H5F</a> +<a href="RM_H5G.html">H5G</a> +<a href="RM_H5P.html">H5P</a> +<!-- +<a href="RM_H5R.html">H5R</a> +--> +<a href="RM_H5S.html">H5S</a> +<a href="RM_H5T.html">H5T</a> +<a href="RM_H5Z.html">H5Z</a> +Tools +<!-- +<a href="Glossary.html">Glossary</a> +--> +</center> +<hr> + +<address> +<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> + +<br> +Last modified: 9 September 1998 + +</body> +</html> |