diff options
author | Frank Baker <fbaker@hdfgroup.org> | 1999-07-06 16:56:15 (GMT) |
---|---|---|
committer | Frank Baker <fbaker@hdfgroup.org> | 1999-07-06 16:56:15 (GMT) |
commit | d70b72d630cba4d78cca0f134e6aa26318efff27 (patch) | |
tree | e15ba2e8cd116865c0911a5420b6abc7e855e0cc /doc | |
parent | e186d84c5f19ea24d300f0771994628d87a2848d (diff) | |
download | hdf5-d70b72d630cba4d78cca0f134e6aa26318efff27.zip hdf5-d70b72d630cba4d78cca0f134e6aa26318efff27.tar.gz hdf5-d70b72d630cba4d78cca0f134e6aa26318efff27.tar.bz2 |
[svn-r1425]
RM_H5S.html
Dataspaces.html
H5Sselect_hyperslab
H5Sselect_elements
Add H5S_SELECT_OR operator.
Converted operator list to a table.
H5Sextent_copy
Corrected source and destination descriptions. (RM_H5S.html only)
H5Screate
Removed unused H5S_NONE dataspace type.
H5Sset_extent_none
Corrected reset class type to H5S_NO_CLASS (previously said H5S_NONE).
RM_H5G.html
H5Gget_linkval
Corrected descriptions of 'loc_id', 'name', and 'value'.
Corrected "Purpose".
Emphasized need to call H5Gget_objinfo first.
H5Gset_comment
H5Gget_comment
Corrected description of 'loc_id'.
H5Gget_objinfo
Corrected description of 'loc_id'.
Added H5G_TYPE to list of valid values of 'type'.
RM_H5F.html
ExternalFiles.html
H5Fmount
H5Funmount
Corrected description of 'loc_id'.
Changed function descriptions in ExternalFiles.html to correspond to RM.
RM_H5T.html
Moved H5Tget_class and H5Tget_size to "General Datatype Operations" in top index.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/html/Dataspaces.html | 50 | ||||
-rw-r--r-- | doc/html/ExternalFiles.html | 7 | ||||
-rw-r--r-- | doc/html/RM_H5F.html | 10 | ||||
-rw-r--r-- | doc/html/RM_H5G.html | 43 | ||||
-rw-r--r-- | doc/html/RM_H5S.html | 54 | ||||
-rw-r--r-- | doc/html/RM_H5T.html | 14 |
6 files changed, 119 insertions, 59 deletions
diff --git a/doc/html/Dataspaces.html b/doc/html/Dataspaces.html index 4f404fd..46eec9c 100644 --- a/doc/html/Dataspaces.html +++ b/doc/html/Dataspaces.html @@ -256,9 +256,8 @@ by calling <TT>H5Sclose()</TT>. <DD> This function creates a new dataspace of a particular <I>type</I>. The -types currently supported are H5S_SCALAR, H5S_SIMPLE, or H5S_NONE, although -others are planned to be added later. The H5S_NONE dataspace can only hold a -selection, not an extent. +types currently supported are H5S_SCALAR and H5S_SIMPLE; +others are planned to be added later. </DD> <DT> @@ -345,7 +344,7 @@ H5S_SIMPLE and the extent is set as specified. <TT>herr_t H5Sset_extent_none (hid_t <I>space</I>)</TT></DT> <DD> -Removes the extent from a dataspace and sets the type to H5S_NONE. +Removes the extent from a dataspace and sets the type to H5S_NO_CLASS. </DD> <DT> @@ -417,11 +416,24 @@ This function selects a hyperslab region to add to the current selected region for the <I>space</I> dataspace. The <I>start</I>, <I>stride</I>, <I>count</I> and <I>block</I> arrays must be the same size as the rank of the dataspace. The selection operator <I>op</I> determines how the new selection is to be -combined with the already existing selection for the dataspace. Currently, -only the H5S_SELECT_SET operator is supported, which replaces the existing -selection with the parameters from this call. Overlapping blocks are not -supported with the H5S_SELECT_SET operator. -<P>The <I>start</I> array determines the starting coordinates of the hyperslab +combined with the already existing selection for the dataspace. +Currently, The following operators are supported: + <dir> + <table width=80% border=0> + <tr><td valign=top> + <code>H5S_SELECT_SET</code> + </td><td valign=top> + Replaces the existing selection with the parameters from this call. + Overlapping blocks are not supported with this operator. + </td></tr><tr><td valign=top> + <code>H5S_SELECT_OR</code> + </td><td valign=top> + Adds the new selection to the existing selection. + </td></tr> + </table> + </dir> +<P> +The <I>start</I> array determines the starting coordinates of the hyperslab to select. The <I>stride</I> array chooses array locations from the dataspace with each value in the <I>stride</I> array determining how many elements to move in each dimension. Setting a value in the <I>stride</I> array to 1 moves to @@ -459,9 +471,23 @@ iterated through when I/O is performed. Duplicate coordinate locations are not checked for. <P>The selection operator <I>op</I> determines how the new selection is to be -combined with the already existing selection for the dataspace. Currently, -only the H5S_SELECT_SET operator is supported, which replaces the existing -selection with the parameters from this call. When operators other than +combined with the already existing selection for the dataspace. +The following operators are supported: + <dir> + <table width=80% border=0> + <tr><td valign=top> + <code>H5S_SELECT_SET</code> + </td><td valign=top> + Replaces the existing selection with the parameters from this call. + Overlapping blocks are not supported with this operator. + </td></tr><tr><td valign=top> + <code>H5S_SELECT_OR</code> + </td><td valign=top> + Adds the new selection to the existing selection. + </td></tr> + </table> + </dir> +When operators other than H5S_SELECT_SET are used to combine a new selection with an existing selection, the selection ordering is reset to 'C' array ordering. </DD> diff --git a/doc/html/ExternalFiles.html b/doc/html/ExternalFiles.html index 91b72c7..c3197af 100644 --- a/doc/html/ExternalFiles.html +++ b/doc/html/ExternalFiles.html @@ -198,12 +198,13 @@ struct H5F_mount_t { </pre></code> <p>The <code>H5Fmount</code> function takes the ID of an open - file, the name of a to-be-mounted file, the name of the mount + file or group, the name of a to-be-mounted file, the name of the mount point, and a file access property list (like <code>H5Fopen</code>). It opens the new file and adds a record to the parent's mount table. The <code>H5Funmount</code> function takes the parent - file ID and the name of the mount point and closes the file - that's mounted at that point. The <code>H5Fclose</code> + file or group ID and the name of the mount point and disassociates + the mounted file from the mount point. It does not close the + mounted file. The <code>H5Fclose</code> function closes/unmounts files recursively. <p>The <code>H5G_iname</code> function which translates a name to diff --git a/doc/html/RM_H5F.html b/doc/html/RM_H5F.html index 4325dd0..7384532 100644 --- a/doc/html/RM_H5F.html +++ b/doc/html/RM_H5F.html @@ -356,12 +356,14 @@ documented below. <code>child_id</code> onto the group specified by <code>loc_id</code> and <code>name</code> using the mount properties <code>plist_id</code>. + <p> + Note that <code>loc_id</code> identifies a file or group. + <code>name</code> then specifies a group relative to <code>loc_id</code>. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>loc_id</code> - <dd>The identifier for the group onto which the - file specified by <code>child_id</code> - is to be mounted. + <dd>The identifier for of file or group in + which <code>name</code> is defined. <dt><em>const char *</em><code>name</code> <dd>The name of the group onto which the file specified by <code>child_id</code> @@ -401,7 +403,7 @@ documented below. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>loc_id</code> - <dd>The identifier for the location at which + <dd>The file or group identifier for the location at which the specified file is to be unmounted. <dt><em>const char *</em><code>name</code> <dd>The name of the file to be unmounted. diff --git a/doc/html/RM_H5G.html b/doc/html/RM_H5G.html index 4b40efe..469b26d 100644 --- a/doc/html/RM_H5G.html +++ b/doc/html/RM_H5G.html @@ -404,8 +404,7 @@ create or access function. <dt><strong>Description:</strong> <dd><code>H5Gget_objinfo</code> returns information about the specified object through the <code>statbuf</code> argument. - <code>loc_id</code> (a file, group, dataset, or - named datatype identifier) and + <code>loc_id</code> (a file or group identifier) and <code>name</code> together determine the object. If the object is a symbolic link and <code>follow_link</code> is zero (<code>0</code>), then the information returned is that for the link itself; @@ -438,8 +437,11 @@ create or access function. symbolic link (symbolic links do not have hard links but all other objects always have at least one). 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>. + one of + <code>H5G_GROUP</code>, + <code>H5G_DATASET</code>, + <code>H5G_LINK</code>, or + <code>H5G_TYPE</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 @@ -453,7 +455,7 @@ create or access function. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: File, group, dataset, or datatype identifier. + <dd>IN: File or group 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> @@ -478,31 +480,36 @@ create or access function. <em>char *</em><code>value</code> ) <dt><strong>Purpose:</strong> - <dd>Returns link value. + <dd>Returns the name of the object that the symbolic link points to. <dt><strong>Description:</strong> <dd><code>H5Gget_linkval</code> returns <code>size</code> - characters of the link value through the <code>value</code> - argument if <code>loc_id</code> (a file or group identifier) - and <code>name</code> specify a symbolic link. - If <code>size</code> is smaller than the link value, then - <code>value</code> will not be null terminated. + characters of the name of the object that the symbolic link <code>name</code> points to. + <p> + The parameter <code>loc_id</code> is a file or group identifier. + <p> + The parameter <code>name</code> must be a symbolic link pointing to + the desired object and must be defined relative to <code>loc_id</code>. + <p> + If <code>size</code> is smaller than the size of the returned object name, then + the name stored in the buffer <code>value</code> will not be null terminated. <p> - This function fails if the specified object is not a symbolic link. + This function fails if <code>name</code> is not a symbolic link. 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>H5Gget_objinfo()</code> to get the size of a link value. + This function should be used only after <code>H5Gget_objinfo()</code> has been called + to verify that <code>name</code> is a symbolic link. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: Identifier of the file, group, dataset, or datatype. + <dd>IN: Identifier of the file or group. <dt><em>const char *</em><code>name</code> - <dd>IN: Name of the object whose link value is to be checked. + <dd>IN: Symbolic link to the object whose name is to be returned. <dt><em>size_t</em> <code>size</code> <dd>IN: Maximum number of characters of <code>value</code> to be returned. <dt><em>char *</em><code>value</code> - <dd>OUT: Link value. + <dd>OUT: A buffer to hold the name of the object being sought. </dl> <dt><strong>Returns:</strong> <dd>Returns a non-negative value, with the link value in <code>value</code>, @@ -542,7 +549,7 @@ create or access function. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: Identifier of the file, group, dataset, or datatype. + <dd>IN: Identifier of the file or group. <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> @@ -579,7 +586,7 @@ create or access function. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>loc_id</code> - <dd>IN: Identifier of the file, group, dataset, or datatype. + <dd>IN: Identifier of the file or group. <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> diff --git a/doc/html/RM_H5S.html b/doc/html/RM_H5S.html index 5a7e33e..c8f0e04 100644 --- a/doc/html/RM_H5S.html +++ b/doc/html/RM_H5S.html @@ -123,10 +123,9 @@ of the <cite>HDF5 User's Guide.</cite>. <dt><strong>Description:</strong> <dd><code>H5Screate</code> creates a new dataspace of a particular <code>type</code>. - The types currently supported are <code>H5S_SCALAR</code>, - <code>H5S_SIMPLE</code>, and <code>H5S_NONE</code>; - others are planned to be added later. The <code>H5S_NONE</code> - dataspace can only hold a selection, not an extent. + The types currently supported are <code>H5S_SCALAR</code> and + <code>H5S_SIMPLE</code>; + others are planned to be added later. <dt><strong>Parameters:</strong> <dl> <dt><em>H5S_class_t</em> <code>type</code> @@ -226,10 +225,23 @@ of the <cite>HDF5 User's Guide.</cite>. <P> The selection operator <code>op</code> determines how the new selection is to be combined with the previously existing - selection for the dataspace. Currently, only the - <code>H5S_SELECT_SET</code> operator is supported, which - replaces the existing selection with the parameters from - this call. When operators other than <code>H5S_SELECT_SET</code> + selection for the dataspace. + The following operators are supported: + <dir> + <table width=80% border=0> + <tr><td valign=top> + <code>H5S_SELECT_SET</code> + </td><td valign=top> + Replaces the existing selection with the parameters from this call. + Overlapping blocks are not supported with this operator. + </td></tr><tr><td valign=top> + <code>H5S_SELECT_OR</code> + </td><td valign=top> + Adds the new selection to the existing selection. + </td></tr> + </table> + </dir> + When operators other than <code>H5S_SELECT_SET</code> are used to combine a new selection with an existing selection, the selection ordering is reset to 'C' array ordering. <dt><strong>Parameters:</strong> @@ -584,10 +596,10 @@ of the <cite>HDF5 User's Guide.</cite>. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>dest_space_id</code> - <dd>IN: The identifier for the dataspace from which + <dd>IN: The identifier for the dataspace to which the extent is copied. <dt><em>hid_t</em> <code>source_space_id</code> - <dd>IN: The identifier for the dataspace to which + <dd>IN: The identifier for the dataspace from which the extent is copied. </dl> <dt><strong>Returns:</strong> @@ -605,7 +617,7 @@ of the <cite>HDF5 User's Guide.</cite>. <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>. + a dataspace and sets the type to <tt>H5S_NO_CLASS</tt>. <dt><strong>Parameters:</strong> <dl> <dt><em>hid_t</em> <code>space_id</code> @@ -644,10 +656,22 @@ of the <cite>HDF5 User's Guide.</cite>. selection is to be combined with the already existing selection for the dataspace. <p> - Currently, only the <code>H5S_SELECT_SET</code> operator is - supported; it replaces the existing selection with the - parameters from this call. Overlapping blocks are not - supported with the <code>H5S_SELECT_SET</code> operator. + The following operators are supported: + <dir> + <table width=80% border=0> + <tr><td valign=top> + <code>H5S_SELECT_SET</code> + </td><td valign=top> + Replaces the existing selection with the parameters from this call. + Overlapping blocks are not supported with this operator. + </td></tr><tr><td valign=top> + <code>H5S_SELECT_OR</code> + </td><td valign=top> + Adds the new selection to the existing selection. + </td></tr> + </table> + </dir> + <P> The <code>start</code> array determines the starting coordinates of the hyperslab diff --git a/doc/html/RM_H5T.html b/doc/html/RM_H5T.html index 8752446..19c65ac 100644 --- a/doc/html/RM_H5T.html +++ b/doc/html/RM_H5T.html @@ -61,11 +61,12 @@ of a dataset. <li><a href="#Datatype-Copy">H5Tcopy</a> <li><a href="#Datatype-Equal">H5Tequal</a> <li><a href="#Datatype-Lock">H5Tlock</a> - <li><a href="#Datatype-Close">H5Tclose</a> -<p> -<i>Atomic Datatype Properties</i> <li><a href="#Datatype-GetClass">H5Tget_class</a> <li><a href="#Datatype-GetSize">H5Tget_size</a> + <li><a href="#Datatype-Close">H5Tclose</a> +<p> +</td><td> </td><td valign=top> +<i>Atomic Datatype</i> <li><a href="#Datatype-SetSize">H5Tset_size</a> <li><a href="#Datatype-GetOrder">H5Tget_order</a> <li><a href="#Datatype-SetOrder">H5Tset_order</a> @@ -73,11 +74,12 @@ of a dataset. <li><a href="#Datatype-SetPrecision">H5Tset_precision</a> <li><a href="#Datatype-GetOffset">H5Tget_offset</a> <li><a href="#Datatype-SetOffset">H5Tset_offset</a> -</td><td> </td><td valign=top> <li><a href="#Datatype-GetPad">H5Tget_pad</a> <li><a href="#Datatype-SetPad">H5Tset_pad</a> <li><a href="#Datatype-GetSign">H5Tget_sign</a> <li><a href="#Datatype-SetSign">H5Tset_sign</a> +</td><td valign=top> +<i>Properties</i> <li><a href="#Datatype-GetFields">H5Tget_fields</a> <li><a href="#Datatype-SetFields">H5Tset_fields</a> <li><a href="#Datatype-GetEbias">H5Tget_ebias</a> @@ -91,10 +93,8 @@ of a dataset. <li><a href="#Datatype-GetStrpad">H5Tget_strpad</a> <li><a href="#Datatype-SetStrpad">H5Tset_strpad</a> <p> -<i>Properties of Compound Types</i> - <li><a href="#Datatype-GetClass">H5Tget_class</a> - <li><a href="#Datatype-GetSize">H5Tget_size</a> </td><td> </td><td valign=top> +<i>Properties of Compound Types</i> <li><a href="#Datatype-GetNmembers">H5Tget_nmembers</a> <li><a href="#Datatype-GetMemberName">H5Tget_member_name</a> <li><a href="#Datatype-GetMemberOffset">H5Tget_member_offset</a> |