diff --git a/doc/html/Glossary.html b/doc/html/Glossary.html index 31b2db6623..9c727a46a6 100644 --- a/doc/html/Glossary.html +++ b/doc/html/Glossary.html @@ -25,23 +25,29 @@ Glossary

HDF5 Glossary

-(Under construction! - This is the bare beginning of a Glossary to accompany the HDF5 documentation; - it is by no means complete.) +(Under construction! + This is the bare beginning of a Glossary to accompany the HDF5 + documentation; it is by no means complete.) -
    -
  1. Basic Types -
  2. Complex Types -
  3. Disk I/O Types -
+ -

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

-Basic Types: +basic data types: -Complex Types: +Complex data types: -Disk I/O Types: +disk I/O data types: diff --git a/doc/html/RM_H5.html b/doc/html/RM_H5.html index 8b2ab70d96..ad2cb8d6c5 100644 --- a/doc/html/RM_H5.html +++ b/doc/html/RM_H5.html @@ -18,7 +18,10 @@ H5   H5S   H5T   H5Z   +Tools   +
@@ -37,8 +40,8 @@ and it users.              
hid_t create_id -
File creation property list identifier, used when modifying +
File creation property list identifier, used when modifying default file meta-data.
hid_t access_id
File access property list identifier. If parallel file access is desired, this is a collective call according to the communicator stored in the - access_id. + access_id. Use 0 for default access properties.
Returns: @@ -166,6 +170,33 @@ documented below. +
+
+
Name: H5Fflush +
Signature: +
herr_t H5Fis_hdf5(hid_t object_id + ) +
Purpose: +
Flushes all buffers associated with a file to disk. +
Description: +
H5Fflush causes all buffers associated with a + file to be immediately flushed to disk without removing the + data from the cache. +

+ object_id can be any object associated with the file, + including the file itself, a dataset, a group, an attribute, or + a named data type. +

Parameters: +
+
const char *object_id +
Identifier of object used to identify the file. +
+
Returns: +
Returns SUCCEED (0) if successful; + otherwise returns FAIL (-1). +
+ +
Name: H5Fis_hdf5 @@ -286,7 +317,10 @@ H5F   H5S   H5T   H5Z   +Tools   +
@@ -294,7 +328,7 @@ H5F   HDF Help Desk
-Last modified: 14 July 1998 +Last modified: 14 August 1998 diff --git a/doc/html/RM_H5Front.html b/doc/html/RM_H5Front.html index 5d8b601434..c3701b806d 100644 --- a/doc/html/RM_H5Front.html +++ b/doc/html/RM_H5Front.html @@ -14,10 +14,16 @@ HDF5 Reference Manual  H5F   H5G   H5P   + H5S   H5T   H5Z   +Tools   +
@@ -40,7 +46,14 @@ tools required to meet specific aspects of the HDF5 data-handling requirements.
  • Error Interface -- The H5E API for error handling.
  • Compression Interface -- The H5Z API for compression.
  • Annotation Interface -- The H5A API for annotations. +
  • Tools -- Interactive tools for the examination of existing HDF5 files. + + @@ -55,18 +68,31 @@ HDF5 Reference Manual  H5F   H5G   H5P   + H5S   H5T   H5Z   +Tools   +
    + + +
    HDF Help Desk -
    -Last modified: 14 July 1998 +Last modified: 8 September 1998 + +    		 +Copyright   +
    + diff --git a/doc/html/RM_H5G.html b/doc/html/RM_H5G.html index 55b7d5bfe1..9b0a8a08b9 100644 --- a/doc/html/RM_H5G.html +++ b/doc/html/RM_H5G.html @@ -18,7 +18,10 @@ H5G   H5S   H5T   H5Z   +Tools   +
    @@ -38,20 +41,22 @@ of objects on disk.
  • H5Gopen
  • H5Gset
  • H5Gclose +
  • H5Gpush               (NYI = Not yet implemented) @@ -279,7 +284,7 @@ then be trivial.
    Parameters:
    hid_t loc_id -
    The file or group identifier. +
    The file, group, dataset, or datatype identifier.
    Returns:
    Returns SUCCEED (0) if successful; @@ -343,7 +348,7 @@ then be trivial.
    Parameters:
    hid_t loc_id -
    File or group identifier. +
    File, group, dataset, or datatype identifier.
    H5G_link_t link_type
    Link type. Possible values are H5G_LINK_HARD and H5G_LINK_SOFT. @@ -501,9 +506,9 @@ then be trivial.
    -
    Name: H5Gstat +
    Name: H5Gget_objinfo
    Signature: -
    herr_t H5Gstat(hid_t loc_id, +
    herr_t H5Gget_objinfo(hid_t loc_id, const char *name, hbool_t follow_link, H5G_stat_t *statbuf @@ -511,7 +516,7 @@ then be trivial.
    Purpose:
    Returns information about an object.
    Description: -
    H5Gstat returns information about the +
    H5Gget_objinfo returns information about the specified object through the statbuf argument. loc_id (a file, group, or dataset identifier) and name 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 statbuf.

    - H5Gstat() fills in the following data structure: + H5Gget_objinfo() fills in the following data structure: 

                       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
    @@ -547,15 +553,20 @@ then be trivial. The type field contains the type of the object, one of H5G_GROUP, H5G_DATASET, or H5G_LINK. + 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 (the name of the pointed-to object with the null terminator); otherwise linklen will be zero. Other fields may be added to this structure in the future. +
    Note: +
    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 mtime value of 0 (zero).
    Parameters:
    hid_t loc_id -
    IN: File, group, or dataset identifier. +
    IN: File, group, dataset, or datatype identifier.
    const char *name
    IN: Name of the object for which status is being sought.
    hbool_t follow_link @@ -564,7 +575,8 @@ then be trivial.
    OUT: Buffer in which to return information about the object.
    Returns: -
    Returns SUCCEED (0) with the fields of STATBUF (if non-null) initialized. +
    Returns SUCCEED (0) with the fields of statbuf + (if non-null) initialized. Otherwise returns FAIL (-1).
    @@ -592,11 +604,11 @@ then be trivial. The presence of a symbolic link can be tested by passing zero for size and NULL for value.

    - Use H5Gstat() to get the size of a link value. + Use H5Gget_objinfo() to get the size of a link value.

    Parameters:
    hid_t loc_id -
    IN: Identifier of the file or group . +
    IN: Identifier of the file, group, dataset, or datatype.
    const char *name
    IN: Name of the object whose link value is to be checked.
    size_t size @@ -612,6 +624,96 @@ then be trivial.
    + + + + +
    +
    +
    Name: H5Gset_comment +
    Signature: +
    herr_t H5Gset_comment(hid_t loc_id, + const char *name, + const char *comment + ) +
    Purpose: +
    Sets comment for specified object. +
    Description: +
    H5Gset_comment sets the comment for the the + object name to comment. + Any previously existing comment is overwritten. +

    + If comment is the empty string or a + null pointer, the comment message is removed from the object. +

    + Comments should be relatively short, null-terminated, + ASCII strings. +

    + 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. +

    Parameters: +
    +
    hid_t loc_id +
    IN: Identifier of the file, group, dataset, or datatype. +
    const char *name +
    IN: Name of the object whose comment is to be set or reset. +
    const char *comment +
    IN: The new comment. +
    +
    Returns: +
    Returns SUCCEED (0) if successful; + otherwise returns FAIL (-1). +
    + + +
    +
    +
    Name: H5Gget_comment +
    Signature: +
    herr_t H5Gget_comment(hid_t loc_id, + const char *name, + size_t bufsize, + char *comment + ) +
    Purpose: +
    Retrieves comment for specified object. +
    Description: +
    H5Gget_comment retrieves the comment for the the + object name. The comment is returned in the buffer + comment. +

    + At most bufsize characters, including a null + terminator, are copied. The result is not null terminated + if the comment is longer than the supplied buffer. +

    + If an object does not have a comment, the empty string + is returned. +

    Parameters: +
    +
    hid_t loc_id +
    IN: Identifier of the file, group, dataset, or datatype. +
    const char *name +
    IN: Name of the object whose comment is to be set or reset. +
    size_t bufsize +
    IN: Anticipated size of the buffer required to hold + comment. +
    char *comment +
    OUT: The comment. +
    +
    Returns: +
    Returns the number of characters in the comment, + counting the null terminator, if successful; the value + returned may be larger than bufsize. + Otherwise returns FAIL (-1). +
    + + + + + + +
    HDF5 Reference Manual  @@ -625,7 +727,10 @@ H5G   H5S   H5T   H5Z   +Tools   +
    @@ -633,7 +738,7 @@ H5G   HDF Help Desk
    -Last modified: 14 July 1998 +Last modified: 2 September 1998 diff --git a/doc/html/RM_H5P.html b/doc/html/RM_H5P.html index 5329ec1c88..d9f1191b1a 100644 --- a/doc/html/RM_H5P.html +++ b/doc/html/RM_H5P.html @@ -18,14 +18,16 @@ H5P   H5S   H5T   H5Z   +Tools   +

    H5P: Property List Interface

    -

    Property List API Functions

    These functions manipulate property list objects to allow objects which require @@ -88,9 +90,14 @@ many different parameters to be easily manipulated.
  • H5Pset_chunk
  • H5Pget_chunk
  • H5Pset_deflate + +
  • H5Pset_filter +
  • H5Pget_nfilters +
  • H5Pget_filter
  • H5Pset_external
  • H5Pget_external_count
  • H5Pget_external @@ -161,7 +168,6 @@ many different parameters to be easily manipulated. otherwise Fail (-1).
    • -
    Name: H5Pclose @@ -439,7 +445,7 @@ many different parameters to be easily manipulated.
    H5Pget_mpi 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.
    Parameters:
    hid_t plist @@ -504,10 +510,10 @@ many different parameters to be easily manipulated.
    Purpose:
    Retrieves the transfer mode from the dataset transfer property list.
    Description: -
    H5Pget_xfer retrieves the transfer mode from the dataset - transfer property list. +
    H5Pget_xfer 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.
    Parameters:
    hid_t plist @@ -532,22 +538,23 @@ many different parameters to be easily manipulated.
    Purpose:
    Sets the size of parameters used to control the symbol table nodes.
    Description: -
    H5Pset_sym_k 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. +
    H5Pset_sym_k 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.

    ik 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 ik.

    - lk 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 + lk 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 lk. + contain 1.5 times the number of symbols specified by + lk.

    Parameters:
    hid_t plist @@ -576,11 +583,12 @@ many different parameters to be easily manipulated. and the symbol table leaf node 1/2 size.
    Description:
    H5Pget_sym_k 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 H5Pset_sym_k - 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 + H5Pset_sym_k for more + information.
    Parameters:
    hid_t plist @@ -607,14 +615,16 @@ many different parameters to be easily manipulated.
    Sets the size of the parameter used to control the B-trees for indexing chunked datasets.
    Description: -
    H5Pset_istore_k 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. +
    H5Pset_istore_k 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.

    - ik 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 ik. + ik 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 + ik.

    Parameters:
    hid_t plist @@ -705,9 +715,9 @@ many different parameters to be easily manipulated.
    Purpose:
    Returns the layout of the raw data for a dataset.
    Description: -
    H5Pget_layout returns the layout of the raw data for a dataset. - This function is only valid for dataset creation property lists. - Valid types for layout are: +
    H5Pget_layout returns the layout of the raw data for + a dataset. This function is only valid for dataset creation + property lists. Valid types for layout are:
      H5D_COMPACT
      Raw data and object header stored contiguously in file. @@ -741,13 +751,14 @@ many different parameters to be easily manipulated.
      Purpose:
      Sets the size of the chunks used to store a chunked layout dataset.
      Description: -
      H5Pset_chunk sets the size of the chunks used to store a chunked - layout dataset. This function is only valid for dataset creation - property lists. The ndims parameter currently must be the - same size as the rank of the dataset. The values of the - dim 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. +
      H5Pset_chunk sets the size of the chunks used to + store a chunked layout dataset. This function is only valid + for dataset creation property lists. + The ndims parameter currently must be the same size + as the rank of the dataset. The values of the dim + 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 is not already.
      Parameters:
      hid_t plist @@ -773,6 +784,7 @@ many different parameters to be easily manipulated. )
      Purpose:
      Retrieves the size of chunks for the raw data of a chunked layout dataset. +
      Description:
      H5Pget_chunk 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.
      Purpose:
      Returns information about an external file.
      Description: -
      H5Pget_external returns information about an external file. - The external file is specified by its index, idx, +
      H5Pget_external returns information about an external + file. The external file is specified by its index, idx, which is a number from zero to N-1, where N is the value returned by H5Pget_external_count(). At most name_size characters are copied into the @@ -975,6 +987,189 @@ many different parameters to be easily manipulated.
      +
      +
      +
      Name: H5Pset_filter +
      Signature: +
      herr_t H5Pset_filter(hid_t plist, + H5Z_filter_t filter, + unsigned int flags, + size_t cd_nelmts, + const unsigned int cd_values[] + ) +
      Purpose: +
      Adds a filter to the filter pipeline. +
      Description: +
      H5Pset_filter adds the specified + filter and corresponding properties to the + end of an output filter pipeline. + If plist is a dataset creation property list, + the filter is added to the permanent filter pipeline; + if plist is a dataset transfer property list, + the filter is added to the transient filter pipeline. +

      + The array cd_values contains + cd_nelmts 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. +

      + The flags argument is a bit vector with + the following fields specifying certain general properties + of the filter: +

      + + + + + + +
      H5Z_FLAG_OPTIONAL  If this bit is set then the filter is + optional. If the filter fails (see below) during an + H5Dwrite() 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 H5Dread() 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 H5Dwrite() + or H5Dread() also fails.
      +
      +
      Note: +
      This function currently supports only the permanent filter + pipeline; plist_id must be a dataset creation + property list. +
      Parameters: +
      +
      hid_t plist +
      IN: Property list identifier. +
      H5Z_filter_t filter +
      IN: Filter to be added to the pipeline. +
      unsigned int flags +
      IN: Bit vector specifying certain general properties + of the filter. +
      size_t cd_nelmts +
      IN: Number of elements in cd_values +
      const unsigned int cd_values[] +
      IN: Auxiliary data for the filter. +
      +
      Returns: +
      Returns SUCCEED (0) if successful; + otherwise FAIL (-1). +
      + + +
      +
      +
      Name: H5Pget_nfilters +
      Signature: +
      int H5Pget_nfilters(hid_t plist) +
      Purpose: +
      Returns the number of filters in the pipeline. +
      Description: +
      H5Pget_nfilters returns the number of filters + defined in the filter pipeline associated with the property list + plist. +

      + In each pipeline, the filters are numbered from + 0 through N-1, where N 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. +

      + H5Pget_nfilters returns the number of filters + in the pipeline, including zero (0) if there + are none. +

      Note: +
      This function currently supports only the permanent filter + pipeline; plist_id must be a dataset creation + property list. +
      Parameters: +
      +
      hid_t plist +
      IN: Property list identifier. +
      +
      Returns: +
      Returns the number of filters in the pipeline if successful; + otherwise returns FAIL (-1). +
      + + +
      +
      +
      Name: H5Pget_filter +
      Signature: +
      H5Z_filter_t H5Pget_filter(hid_t plist, + int filter_number, + unsigned int *flags, + size_t *cd_nelmts, + unsigned int *cd_values, + size_t namelen, + char name[] + ) +
      Purpose: +
      Returns information about a filter in a pipeline. +
      Description: +
      + H5Pget_filter returns information about a + filter, specified by its filter number, in a filter pipeline, + specified by the property list with which it is associated. +

      + If plist is a dataset creation property list, + the pipeline is a permanent filter pipeline; + if plist is a dataset transfer property list, + the pipeline is a transient filter pipeline. +

      + On input, cd_nelmts indicates the number of entries + in the cd_values array, as allocated by the caller; + on return,cd_nelmts contains the number of values + defined by the filter. +

      + filter_number is a value between zero and + N-1, as described in + H5Pget_nfilters(). + The function will return FAIL (-1) if the filter number is out + of range. +

      + If name is a pointer to an array of at least + namelen bytes, the filter name will be copied + into that array. The name will be null terminated if + namelen 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. +

      + The structure of the flags argument is discussed + in H5Pset_filter(). +

      Note: +
      This function currently supports only the permanent filter + pipeline; plist must be a dataset creation property + list. +
      Parameters: +
      +
      hid_t plist +
      IN: Property list identifier. +
      int filter_number +
      IN: Sequence number within the filter pipeline of + the filter for which information is sought. +
      unsigned int *flags +
      OUT: Bit vector specifying certain general properties + of the filter. +
      size_t *cd_nelmts +
      IN/OUT: Number of elements in cd_values +
      unsigned int *cd_values +
      OUT: Auxiliary data for the filter. +
      size_t namelen +
      IN: Anticipated number of characters in name. +
      char name[] +
      OUT: Name of the filter. +
      +
      Returns: +
      Returns the filter identification number if successful. + Otherwise returns H5Z_FILTER_ERROR (-1). +
      + +
      Name: H5Pget_driver @@ -1015,9 +1210,8 @@ many different parameters to be easily manipulated. in the stdio.h.
      Description:
      H5Pset_stdio 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().
      Parameters:
      hid_t plist @@ -1113,13 +1307,14 @@ many different parameters to be easily manipulated.
      Purpose:
      Sets the low-level file driver to use malloc() and free().
      Description: -
      H5Pset_core sets the low-level file driver to use malloc() and free(). +
      H5Pset_core sets the low-level file driver to use + malloc() and free(). 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 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.
      Parameters:
      hid_t plist @@ -1146,10 +1341,10 @@ many different parameters to be easily manipulated.
      Description:
      H5Pget_core 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 + increment 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 H5Pset_core().
      Parameters:
      hid_t plist @@ -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 meta_extension (recommended - default value: .meta) to the end of the base name + default value: .meta) to the end of the base name and will be accessed according to the meta_properties. The raw file will have a name which is formed by appending raw_extension (recommended default value: @@ -1228,15 +1423,15 @@ many different parameters to be easily manipulated.
      H5Pget_split checks to determine whether the file access property list is set to the split driver. On successful return, - meta_properties and raw_properties will + meta_properties and raw_properties will point to copies of the meta and raw access property lists which should be closed by calling H5Pclose() 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 - meta_extension and/or raw_extension are - non-null pointers, at most meta_ext_size or - raw_ext_size characters of the meta or raw file name + meta_extension and/or raw_extension are + non-null pointers, at most meta_ext_size or + raw_ext_size 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.
      Sets the file access properties list to the family driver.
      Description: +
      Original version. Edited version below.
      H5Pset_family sets the file access properties to use the family driver; any previously defined driver properties are erased @@ -1313,6 +1509,60 @@ many different parameters to be easily manipulated.
      +
      +
      +
      Name: H5Pset_family +
      Signature: +
      herr_t H5Pset_family(hid_t plist, + hsize_t memb_size, + hid_t memb_plist + ) +
      Purpose: +
      Sets the file access properties list to the family + driver. +
      Description: +
      Edited version. Original version above. +
      H5Pset_family sets the file access properties + to use the family driver; any previously defined + driver properties are erased from the property list. + See File Families + in the HDF5 User's Guide for a discussion + of file families. +

      + Each member of the file family will use memb_plist + as its file access property list. +

      + The memb_size 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. +

      + Note: If the size of the off_t 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. +

      + Additional parameters may be added to this function in the + future. +

      Parameters: +
      +
      hid_t plist +
      IN: Identifier of the file access property list. +
      hsize_t memb_size +
      IN: Logical size, in bytes, of each family member. +
      hid_t memb_plist +
      IN: Identifier of the file access property list + for each member of the family. +
      +
      Returns: +
      Returns SUCCEED (0) if successful; + otherwise FAIL (-1). +
      + +
      Name: H5Pget_family @@ -1365,8 +1615,9 @@ many different parameters to be easily manipulated.
      Sets the number of elements in the meta data cache and the total number of bytes in the raw data chunk cache.
      Description: -
      H5Pset_cache sets the number of elements (objects) in the meta data cache and the - total number of bytes in the raw data chunk cache. +
      H5Pset_cache sets the number of elements (objects) + in the meta data cache and the total number of bytes in the + raw data chunk cache.

      Sets or queries the meta data cache and raw data chunk cache parameters. The plist 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.

      - If TCONV and/or BKG are null pointers then buffers will be - allocated and freed during the data transfer. + If tconv and/or bkg are null pointers, + then buffers will be allocated and freed during the data transfer.

      The default value for the maximum buffer is 1 Mb.

      Parameters: @@ -1562,6 +1813,8 @@ many different parameters to be easily manipulated.
      + + + + +
      @@ -1658,12 +1919,11 @@ many different parameters to be easily manipulated.
      Sets compression method and compression level.
      Description:
      H5Pset_deflate 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 H5D_COMPRESS_DEFLATE + and the compression level to 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.
      Parameters:
      hid_t plist @@ -1677,6 +1937,8 @@ many different parameters to be easily manipulated.
      + +
      @@ -1713,15 +1977,20 @@ H5P   H5S   H5T   H5Z   +Tools   +
      +
      HDF Help Desk
      -Last modified: 14 July 1998 +Last modified: 25 August 1998 + diff --git a/doc/html/RM_H5R.html b/doc/html/RM_H5R.html new file mode 100644 index 0000000000..4e1fd7ca2f --- /dev/null +++ b/doc/html/RM_H5R.html @@ -0,0 +1,248 @@ + + +HDF5/H5R Draft API Specification + + + + +
      +
      +HDF5 Reference Manual  +H5   +H5A   +H5D   +H5E   +H5F   +H5G   +H5P   +H5R   +H5S   +H5T   +H5Z   +Tools   + +
      +
      + +
      +

      H5R: Ragged Array Interface

      +
      + +

      Ragged Array API Functions

      + + +
      + +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. +

      Use these functions at your own risk!
      +Do not create any archives using this interface!
      +       +
      +

      +These functions enable the user to store and retrieve data in ragged arrays. + + + + +
      + +       + +
      + +

      + + + +

      +
      +
      Name: H5Rcreate +
      Signature: +
      H5Rcreate( , + , + + ) +
      Purpose: +
      +
      Description: +
      H5Rcreate +
      Parameters: +
      +
      +
      +
      +
      +
      +
      +
      +
      Returns: +
      Returns SUCCEED (0) if successful; + otherwise FAIL (-1). +
      + + +
      +
      +
      Name: H5Ropen +
      Signature: +
      H5Ropen( , + , + + ) +
      Purpose: +
      +
      Description: +
      H5Ropen +
      Parameters: +
      +
      +
      +
      +
      +
      +
      +
      +
      Returns: +
      Returns SUCCEED (0) if successful; + otherwise FAIL (-1). +
      + + +
      +
      +
      Name: H5Rclose +
      Signature: +
      H5Rclose( , + , + + ) +
      Purpose: +
      +
      Description: +
      H5Rclose +
      Parameters: +
      +
      +
      +
      +
      +
      +
      +
      +
      Returns: +
      Returns SUCCEED (0) if successful; + otherwise FAIL (-1). +
      + + +
      +
      +
      Name: H5Rwrite +
      Signature: +
      H5Rwrite( , + , + + ) +
      Purpose: +
      +
      Description: +
      H5Rwrite +

      + Datatype conversion takes place at the time of a read or write + and is automatic. See the + Data Conversion + section of The Data Type Interface (H5T) in the + HDF5 User's Guide for a discussion of + data conversion, including the range of conversions currently + supported by the HDF5 libraries. +

      Parameters: +
      +
      +
      +
      +
      +
      +
      +
      +
      Returns: +
      Returns SUCCEED (0) if successful; + otherwise FAIL (-1). +
      + + +
      +
      +
      Name: H5Rread +
      Signature: +
      H5Rread( , + , + + ) +
      Purpose: +
      +
      Description: +
      H5Rread +

      + Datatype conversion takes place at the time of a read or write + and is automatic. See the + Data Conversion + section of The Data Type Interface (H5T) in the + HDF5 User's Guide for a discussion of + data conversion, including the range of conversions currently + supported by the HDF5 libraries. +

      Parameters: +
      +
      +
      +
      +
      +
      +
      +
      +
      Returns: +
      Returns SUCCEED (0) if successful; + otherwise FAIL (-1). +
      + + +
      +
      +HDF5 Reference Manual  +H5   +H5A   +H5D   +H5E   +H5F   +H5G   +H5P   +H5R   +H5S   +H5T   +H5Z   +Tools   + +
      +
      + +
      +HDF Help Desk + +
      +Last modified: 1 September 1998 + + + diff --git a/doc/html/RM_H5S.html b/doc/html/RM_H5S.html index 6230e569a7..64fd250bfe 100644 --- a/doc/html/RM_H5S.html +++ b/doc/html/RM_H5S.html @@ -18,7 +18,10 @@ HDF5/H5S Draft API Specification H5S   H5T   H5Z   +Tools   +
      @@ -36,27 +39,62 @@ elements of a dataset. -       -        +       + +

      +The following H5S functions are included in the HDF5 specification, +but have not yet been implemented. They are described in the +The Data Type Interface (H5T) section +of the HDF5 User's Guide.. + + +
      +
        +
      • H5Scommit +
      • H5Sis_subspace +
      • H5Slock +
      • H5Sopen +
      +      		       +
        +
      • H5Sselect_name +
      • H5Sselect_op +
      • H5Sselect_order +
      +      		       +
        +
      • H5Ssubspace +
      • H5Ssubspace_name +
      • H5Ssubspace_location +
      +
      +

      @@ -196,18 +234,89 @@ elements of a dataset.
      - +
      +
      +
      Name: H5Sselect_all +
      Signature: +
      herr_t H5Sselect_all(hid_t space_id) +
      Purpose: +
      Selects the entire dataspace. +
      Description: +
      H5Sselect_all selects the entire extent + of the dataspace space_id. +

      + More specifically, H5Sselect_all selects + the special 5S_SELECT_ALL region for the dataspace + space_id. H5S_SELECT_ALL selects the + entire dataspace for any dataspace it is applied to. +

      Parameters: +
      +
      hid_t space_id +
      IN: The identifier for the dataspace in which the + selection is being made. +
      +
      Returns: +
      Returns SUCCEED (0) if successful; + otherwise FAIL (-1). +
      -
      Name: H5Sextent_npoints +
      Name: H5Sselect_none
      Signature: -
      hsize_t H5Sextent_npoints(hid_t space_id) +
      herr_t H5Sselect_none(hid_t space_id) +
      Purpose: +
      Resets the selection region to include no elements. +
      Description: +
      H5Sselect_none resets the selection region + for the dataspace space_id to include no elements. +
      Parameters: +
      +
      hid_t space_id +
      IN: The identifier for the dataspace in which the + selection is being reset. +
      +
      Returns: +
      Returns SUCCEED (0) if successful; + otherwise FAIL (-1). +
      + + +
      +
      +
      Name: H5Sselect_valid +
      Signature: +
      hbool_t H5Sselect_valid(hid_t space_id) +
      Purpose: +
      Verifies that the selection is within the extent of the dataspace. +
      Description: +
      H5Sselect_valid verifies that the selection + for the dataspace space_id is within the extent + of the dataspace if the current offset for the dataspace is used. +
      Parameters: +
      +
      hid_t space_id +
      The identifier for the dataspace in which the + selection is being reset. +
      +
      Returns: +
      Returns TRUE if the selection is contained within + the extent and FALSE if it is not. + Returns FAIL (-1) on error conditions + such as the selection or extent not being defined. +
      + + +
      +
      +
      Name: H5Sget_simple_extent_npoints +
      Signature: +
      hsize_t H5Sget_simple_extent_npoints(hid_t space_id)
      Purpose:
      Determines the number of elements in a dataspace.
      Description: -
      H5Sextent_npoints determines the number of elements +
      H5Sget_simple_extent_npoints 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.
      Parameters: @@ -223,13 +332,13 @@ elements of a dataset.
      -
      Name: H5Sselect_npoints +
      Name: H5Sget_select_npoints
      Signature: -
      hsize_t H5Sselect_npoints(hid_t space_id) +
      hsize_t H5Sget_select_npoints(hid_t space_id)
      Purpose:
      Determines the number of elements in a dataspace.
      Description: -
      H5Sselect_npoints determines the number of elements +
      H5Sget_select_npoints determines the number of elements in the current selection of a dataspace.
      Parameters:
      @@ -237,20 +346,20 @@ elements of a dataset.
      Dataspace identifier.
      Returns: -
      Returns a dataspace identifier if successful; +
      Returns the number of elements in the selection if successful; otherwise FAIL (-1).
      -
      Name: H5Sextent_ndims +
      Name: H5Sget_simple_extent_ndims
      Signature: -
      int H5Sextent_ndims(hid_t space_id) +
      int H5Sget_simple_extent_ndims(hid_t space_id)
      Purpose:
      Determines the dimensionality of a dataspace.
      Description: -
      H5Sextent_ndims determines the dimensionality (or rank) +
      H5Sget_simple_extent_ndims determines the dimensionality (or rank) of a dataspace.
      Parameters:
      @@ -265,16 +374,16 @@ elements of a dataset.
      -
      Name: H5Sextent_dims +
      Name: H5Sget_simple_extent_dims
      Signature: -
      int H5Sextent_dims(hid_t space_id, +
      int H5Sget_simple_extent_dims(hid_t space_id, hsize_t *dims, hsize_t *maxdims )
      Purpose:
      Retrieves dataspace dimension size and maximum size.
      Description: -
      H5Sextent_dims returns the size and maximum sizes +
      H5Sget_simple_extent_dims returns the size and maximum sizes of each dimension of a dataspace through the dims and maxdims parameters.
      Parameters: @@ -292,11 +401,37 @@ elements of a dataset.
      +
      +
      +
      Name: H5Sget_space_type +
      Signature: +
      H5S_class_t H5Sget_space_type(hid_t space_id) +
      Purpose: +
      Determine the current class of a dataspace. +
      Description: +
      H5Sget_space_type queries a dataspace to determine the + current class of a dataspace. +

      + The function returns a class name, one of the following: + H5S_SCALAR, + H5S_SIMPLE, or + H5S_NONE. +

      Parameters: +
      +
      hid_t space_id +
      Dataspace identifier. +
      +
      Returns: +
      Returns a dataspace class name if successful; + otherwise FAIL (-1). +
      + +
      Name: H5Sset_extent_simple
      Signature: -
      herr_t H5S_set_extent_simple(hid_t space_id, +
      herr_t H5Sset_extent_simple(hid_t space_id, int rank, const hsize_t *current_size, const hsize_t *maximum_size @@ -304,7 +439,7 @@ elements of a dataset.
      Purpose:
      Sets or resets the size of an existing dataspace.
      Description: -
      H5S_set_extent_simple sets or resets the size of +
      H5Sset_extent_simple sets or resets the size of an existing dataspace.

      rank is the dimensionality, or number of @@ -360,19 +495,51 @@ elements of a dataset.

      -
      Name: H5Sget_class +
      Name: H5Soffset_simple
      Signature: -
      H5S_class_t H5Sget_class(hid_t space_id) +
      herr_t H5Soffset_simple(hid_t space_id, + const hssize_t *offset + ) +
      Purpose: +
      Sets the offset of a simple dataspace. +
      Description: +
      H5Soffset_simple sets the offset of a + simple dataspace space_id. The offset + array must be the same number of elements as the number of + dimensions for the dataspace. If the offset + array is set to NULL, the offset for the dataspace + is reset to 0. +

      + This function allows the same shaped selection to be moved + to different locations within a dataspace without requiring it + to be redefined. +

      Parameters: +
      +
      hid_t space_id +
      IN: The identifier for the dataspace object to reset. +
      const hssize_t *offset +
      IN: The offset at which to position the selection. +
      +
      Returns: +
      Returns SUCCEED (0) if successful; + otherwise FAIL (-1). +
      + + +
      +
      +
      Name: H5Sextent_class +
      Signature: +
      H5S_class_t H5Sextent_class(hid_t space_id)
      Purpose:
      Determine the current class of a dataspace.
      Description: -
      H5Sget_class queries a dataspace to determine the +
      H5Sextent_class queries a dataspace to determine the current class of a dataspace.

      The function returns a class name, one of the following: H5S_SCALAR, - H5S_SIMPLE, or - H5S_NONE. + H5S_SIMPLE.

      Parameters:
      hid_t space_id @@ -380,6 +547,56 @@ elements of a dataset.
      Returns:
      Returns a dataspace class name if successful; + otherwise H5S_NO_CLASS (-1). +
      + + +
      +
      +
      Name: H5Sextent_copy +
      Signature: +
      herr_t H5Sextent_copy(hid_t dest_space_id, + hid_t source_space_id + ) +
      Purpose: +
      Copies the extent of a dataspace. +
      Description: +
      H5Sextent_copy copies the extent from + source_space_id to dest_space_id. + This action may change the type of the dataspace. +
      Parameters: +
      +
      hid_t dest_space_id +
      IN: The identifier for the dataspace from which + the extent is copied. +
      hid_t source_space_id +
      IN: The identifier for the dataspace to which + the extent is copied. +
      +
      Returns: +
      Returns SUCCEED (0) if successful; + otherwise FAIL (-1). +
      + + +
      +
      +
      Name: H5Sset_extent_none +
      Signature: +
      herr_t H5Sset_extent_none(hid_t space_id) +
      Purpose: +
      Removes the extent from a dataspace. +
      Description: +
      H5Sset_extent_none removes the extent from + a dataspace and sets the type to H5S_NONE. +
      Parameters: +
      +
      hid_t space_id +
      The identifier for the dataspace from which + the extent is to be removed. +
      +
      Returns: +
      Returns SUCCEED (0) if successful; otherwise FAIL (-1).
      @@ -515,7 +732,10 @@ I/O is performed. H5S   H5T   H5Z   +Tools   +
      @@ -523,7 +743,7 @@ H5S   HDF Help Desk
      -Last modified: 14 July 1998 +Last modified: 1 September 1998 diff --git a/doc/html/RM_H5T.html b/doc/html/RM_H5T.html index 0fa59262dd..086b9cc14c 100644 --- a/doc/html/RM_H5T.html +++ b/doc/html/RM_H5T.html @@ -18,7 +18,10 @@ HDF5/H5T Draft API Specification H5S   H5T   H5Z   +Tools   +
      @@ -121,7 +124,7 @@ A data point is an instance of a datatype,

      See The Datatype Interface (H5T) -in the HDF5 User's Guide for further information. +in the HDF5 User's Guide for further information, including a complete list of all supported datatypes.

      @@ -142,7 +145,7 @@ in the HDF5 User's Guide for further information.
      Parameters:
      hid_t loc_id -
      A file or group identifier. +
      A file, group, or datatype identifier.
      const char * name
      A datatype name.
      @@ -489,6 +492,14 @@ H5Tget_overflow ()
      Native single-precision float type, declare dataset array as 'float'
      H5T_NATIVE_DOUBLE
      Native double-precision float type, declare dataset array as 'double' +
      H5T_NATIVE_HSIZE +
      Native size_t type, declare dataset array as 'hsize_t' +
      H5T_NATIVE_HSSIZE +
      Native signed size_t type, declare dataset array as 'hssize_t' +
      H5T_NATIVE_HERR +
      Native error type, declare dataset array as 'herr_t' +
      H5T_NATIVE_HBOOL +
      Native boolean type, declare dataset array as 'hbool_t'
    -->
    Parameters: @@ -1741,7 +1752,10 @@ zero. H5S   H5T   H5Z   +Tools   +
    @@ -1749,7 +1763,7 @@ H5T   HDF Help Desk
    -Last modified: 14 July 1998 +Last modified: 2 September 1998 diff --git a/doc/html/RM_H5Z.html b/doc/html/RM_H5Z.html index dbaed4ccb6..5cdc5c8347 100644 --- a/doc/html/RM_H5Z.html +++ b/doc/html/RM_H5Z.html @@ -18,7 +18,10 @@ HDF5/H5Z Draft API Specification H5S   H5T   H5Z   +Tools   +
    @@ -109,7 +112,10 @@ See Compression in the H5S   H5T   H5Z   +Tools   +
    diff --git a/doc/html/Tools.html b/doc/html/Tools.html new file mode 100644 index 0000000000..b19b57c725 --- /dev/null +++ b/doc/html/Tools.html @@ -0,0 +1,259 @@ + + +HDF5/Tools Draft API Specification + + + + +
    +
    +HDF5 Reference Manual  +H5   +H5A   +H5D   +H5E   +H5F   +H5G   +H5P   + +H5S   +H5T   +H5Z   +Tools   + +
    +
    + +
    +

    HDF5 Tools

    +
    + +

    HDF5 Tool Interfaces

    +

    +These tools enable the user to examine HDF5 files interactively. + + + + +
    +
      +
    • h5dump -- A tool for displaying + HDF5 file contents +
    • h5ls -- A tool for listing specified + features of HDF5 file contents +
    • h5repart -- A tool for repartitioning + a file, creating a family of files +
    +
    + +

    + + +

    +
    +
    Tool Name: h5dump +
    Syntax: +
    h5dump + [-h] + [-bb] + [-header] + [-a names] + [-d names] + [-g names] + [-l names] + files +
    Purpose: +
    Displays HDF5 file contents. +
    Description: +
    h5dump 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. +

    + h5dump 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. +

    + The -header option displays object + header information only and must appear before the + -a, -d, -g, or + -l options. +

    + The h5dump output is described in detail in + DDL, the Data Description + Language document. +

    Options and Parameters: +
    +
    -h +
    Print information on this command. +
    -bb +
    Displays the content of boot block. The default is + not to display. +
    -header +
    Displays header information only; no data is displayed. +
    -a names +
    Displays the specified attribute(s). +
    -d names +
    Displays the specified dataset(s). +
    -g names +
    Displays all the objects within the specified group(s). +
    -l names +
    Displays the specified link value(s). +
    files +
    The file(s) to be examined. +
    +
    Current Status: +
    The current version of h5dump can display the + following types of information: +
      +
    • Group name +
    • Attribute name, data type, adata space, and data +
    • Dataset name, data type, data space, and data +
    • Soft link name, link value +
    + +
    Limitions in the current implementaion include the + following: +
      +
    • Only one file is displayed at a time (file families are + not supported). +
    • The whole file content is displayed (none of above + options are supported). +
    • Compound data types are not yet supported. +
    • Complex data spaces are not yet supported. +
    +
    See Also: +
    HDF5 Data Description Language syntax + (DDL) +
    + + +
    +
    +
    Tool Name: h5ls +
    Syntax: +
    h5ls + [options] + file + [objects...] +
    Purpose: +
    Prints information about a file or dataset. +
    Description: +
    h5ls prints selected information about file objects + in the specified format. +
    Options and Parameters: +
    +
    -h   or   -?   or   --help +
    Print a usage message and exit. +
    -d   or   --dump +
    Print the values of datasets. +
    -wN   or   --width=N +
    Set the number of columns of output. +
    -v   or   --verbose +
    Generate more verbose output. +
    -V   or   --version +
    Print version number and exit. +
    file +
    The file name may include a printf(3C) integer format + such as %%05d to open a file family. +
    objects +
    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. +
    + +
    + + +
    +
    +
    Tool Name: h5repart +
    Syntax: +
    h5repart + [-v] + [-V] + [-[b|m]N[g|m|k]] + source_file + dest_file +
    Purpose: +
    Repartitions a file or family of files. +
    Description: +
    h5repart 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. h5repart can also be used to + copy a single file to a single file with holes. +

    + Sizes associated with the -b and -m + options may be suffixed with g for gigabytes, + m for megabytes, or k for kilobytes. +

    + File family names include an integer printf + format such as %d. + +

    Options and Parameters: +
    +
    -v +
    Produce verbose output. +
    -V +
    Print a version number and exit. +
    -bN +
    The I/O block size, defaults to 1kB +
    -mN +
    The destination member size or 1GB +
    source_file +
    The name of the source file +
    dest_file +
    The name of the destination files +
    + +
    + + +
    +
    +HDF5 Reference Manual  +H5   +H5A   +H5D   +H5E   +H5F   +H5G   +H5P   + +H5S   +H5T   +H5Z   +Tools   + +
    +
    + +
    +HDF Help Desk + +
    +Last modified: 9 September 1998 + + +