From d70b72d630cba4d78cca0f134e6aa26318efff27 Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Tue, 6 Jul 1999 11:56:15 -0500 Subject: [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. --- doc/html/Dataspaces.html | 50 +++++++++++++++++++++++++++++++---------- doc/html/ExternalFiles.html | 7 +++--- doc/html/RM_H5F.html | 10 +++++---- doc/html/RM_H5G.html | 43 +++++++++++++++++++++--------------- doc/html/RM_H5S.html | 54 ++++++++++++++++++++++++++++++++------------- 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 H5Sclose().
This function creates a new dataspace of a particular type. 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.
@@ -345,7 +344,7 @@ H5S_SIMPLE and the extent is set as specified. herr_t H5Sset_extent_none (hid_t space)
-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.
@@ -417,11 +416,24 @@ This function selects a hyperslab region to add to the current selected region for the space dataspace. The start, stride, count and block arrays must be the same size as the rank of the dataspace. The selection operator op 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. -

The start array determines the starting coordinates of the hyperslab +combined with the already existing selection for the dataspace. +Currently, The following operators are supported: +

+ + +
+ H5S_SELECT_SET + + Replaces the existing selection with the parameters from this call. + Overlapping blocks are not supported with this operator. +
+ H5S_SELECT_OR + + Adds the new selection to the existing selection. +
+ +

+The start array determines the starting coordinates of the hyperslab to select. The stride array chooses array locations from the dataspace with each value in the stride array determining how many elements to move in each dimension. Setting a value in the stride array to 1 moves to @@ -459,9 +471,23 @@ iterated through when I/O is performed. Duplicate coordinate locations are not checked for.

The selection operator op 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: +

+ + +
+ H5S_SELECT_SET + + Replaces the existing selection with the parameters from this call. + Overlapping blocks are not supported with this operator. +
+ H5S_SELECT_OR + + Adds the new selection to the existing selection. +
+ +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. 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 {

The H5Fmount 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 H5Fopen). It opens the new file and adds a record to the parent's mount table. The H5Funmount function takes the parent - file ID and the name of the mount point and closes the file - that's mounted at that point. The H5Fclose + 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 H5Fclose function closes/unmounts files recursively.

The H5G_iname 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. child_id onto the group specified by loc_id and name using the mount properties plist_id. +

+ Note that loc_id identifies a file or group. + name then specifies a group relative to loc_id.

Parameters:
hid_t loc_id -
The identifier for the group onto which the - file specified by child_id - is to be mounted. +
The identifier for of file or group in + which name is defined.
const char *name
The name of the group onto which the file specified by child_id @@ -401,7 +403,7 @@ documented below.
Parameters:
hid_t loc_id -
The identifier for the location at which +
The file or group identifier for the location at which the specified file is to be unmounted.
const char *name
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.
Description:
H5Gget_objinfo returns information about the specified object through the statbuf argument. - loc_id (a file, group, dataset, or - named datatype identifier) and + loc_id (a file or group identifier) and name together determine the object. If the object is a symbolic link and follow_link is zero (0), 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 type field contains the type of the object, - one of H5G_GROUP, H5G_DATASET, - or H5G_LINK. + one of + H5G_GROUP, + H5G_DATASET, + H5G_LINK, or + H5G_TYPE. The mtime field contains the modification time. If information is being returned about a symbolic link then linklen will be the length of the link value @@ -453,7 +455,7 @@ create or access function.
Parameters:
hid_t loc_id -
IN: File, group, dataset, or datatype identifier. +
IN: File or group identifier.
const char *name
IN: Name of the object for which status is being sought.
hbool_t follow_link @@ -478,31 +480,36 @@ create or access function. char *value )
Purpose: -
Returns link value. +
Returns the name of the object that the symbolic link points to.
Description:
H5Gget_linkval returns size - characters of the link value through the value - argument if loc_id (a file or group identifier) - and name specify a symbolic link. - If size is smaller than the link value, then - value will not be null terminated. + characters of the name of the object that the symbolic link name points to. +

+ The parameter loc_id is a file or group identifier. +

+ The parameter name must be a symbolic link pointing to + the desired object and must be defined relative to loc_id. +

+ If size is smaller than the size of the returned object name, then + the name stored in the buffer value will not be null terminated.

- This function fails if the specified object is not a symbolic link. + This function fails if name is not a symbolic link. The presence of a symbolic link can be tested by passing zero for size and NULL for value.

- Use H5Gget_objinfo() to get the size of a link value. + This function should be used only after H5Gget_objinfo() has been called + to verify that name is a symbolic link.

Parameters:
hid_t loc_id -
IN: Identifier of the file, group, dataset, or datatype. +
IN: Identifier of the file or group.
const char *name -
IN: Name of the object whose link value is to be checked. +
IN: Symbolic link to the object whose name is to be returned.
size_t size
IN: Maximum number of characters of value to be returned.
char *value -
OUT: Link value. +
OUT: A buffer to hold the name of the object being sought.
Returns:
Returns a non-negative value, with the link value in value, @@ -542,7 +549,7 @@ create or access function.
Parameters:
hid_t loc_id -
IN: Identifier of the file, group, dataset, or datatype. +
IN: Identifier of the file or group.
const char *name
IN: Name of the object whose comment is to be set or reset.
const char *comment @@ -579,7 +586,7 @@ create or access function.
Parameters:
hid_t loc_id -
IN: Identifier of the file, group, dataset, or datatype. +
IN: Identifier of the file or group.
const char *name
IN: Name of the object whose comment is to be set or reset.
size_t bufsize 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 HDF5 User's Guide..
Description:
H5Screate creates a new dataspace of a particular type. - The types currently supported are H5S_SCALAR, - H5S_SIMPLE, and H5S_NONE; - others are planned to be added later. The H5S_NONE - dataspace can only hold a selection, not an extent. + The types currently supported are H5S_SCALAR and + H5S_SIMPLE; + others are planned to be added later.
Parameters:
H5S_class_t type @@ -226,10 +225,23 @@ of the HDF5 User's Guide..

The selection operator op determines how the new selection is to be combined with the previously 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 H5S_SELECT_SET + selection for the dataspace. + The following operators are supported: +

+ + +
+ H5S_SELECT_SET + + Replaces the existing selection with the parameters from this call. + Overlapping blocks are not supported with this operator. +
+ H5S_SELECT_OR + + Adds the new selection to the existing selection. +
+ + 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.
Parameters: @@ -584,10 +596,10 @@ of the HDF5 User's Guide..
Parameters:
hid_t dest_space_id -
IN: The identifier for the dataspace from which +
IN: The identifier for the dataspace to which the extent is copied.
hid_t source_space_id -
IN: The identifier for the dataspace to which +
IN: The identifier for the dataspace from which the extent is copied.
Returns: @@ -605,7 +617,7 @@ of the HDF5 User's Guide..
Removes the extent from a dataspace.
Description:
H5Sset_extent_none removes the extent from - a dataspace and sets the type to H5S_NONE. + a dataspace and sets the type to H5S_NO_CLASS.
Parameters:
hid_t space_id @@ -644,10 +656,22 @@ of the HDF5 User's Guide.. selection is to be combined with the already existing selection for the dataspace.

- Currently, only the H5S_SELECT_SET operator is - supported; it replaces the existing selection with the - parameters from this call. Overlapping blocks are not - supported with the H5S_SELECT_SET operator. + The following operators are supported: +

+ + +
+ H5S_SELECT_SET + + Replaces the existing selection with the parameters from this call. + Overlapping blocks are not supported with this operator. +
+ H5S_SELECT_OR + + Adds the new selection to the existing selection. +
+ +

The start 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.

  • H5Tcopy
  • H5Tequal
  • H5Tlock -
  • H5Tclose -

    -Atomic Datatype Properties

  • H5Tget_class
  • H5Tget_size +
  • H5Tclose +

    +       +Atomic Datatype

  • H5Tset_size
  • H5Tget_order
  • H5Tset_order @@ -73,11 +74,12 @@ of a dataset.
  • H5Tset_precision
  • H5Tget_offset
  • H5Tset_offset -      
  • H5Tget_pad
  • H5Tset_pad
  • H5Tget_sign
  • H5Tset_sign + +Properties
  • H5Tget_fields
  • H5Tset_fields
  • H5Tget_ebias @@ -91,10 +93,8 @@ of a dataset.
  • H5Tget_strpad
  • H5Tset_strpad

    -Properties of Compound Types -

  • H5Tget_class -
  • H5Tget_size        +Properties of Compound Types
  • H5Tget_nmembers
  • H5Tget_member_name
  • H5Tget_member_offset -- cgit v0.12