From 6e2071f7eddbfce07ca98c23da3698fadd436b5a Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Wed, 2 Apr 2003 16:24:47 -0500 Subject: [svn-r6570] Purpose: New feature: Fill value and storage space allocation changes Description: Modified the following functions: H5Pset_fill_value H5Pget_fill_value Added the following functions: H5Pfill_value_defined H5Pset_fill_time H5Pget_fill_time H5Pset_alloc_time H5Pget_alloc_time Platforms tested: Safari, IE 5 --- doc/html/RM_H5P.html | 448 ++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 406 insertions(+), 42 deletions(-) diff --git a/doc/html/RM_H5P.html b/doc/html/RM_H5P.html index 450599c..1cf79d5 100644 --- a/doc/html/RM_H5P.html +++ b/doc/html/RM_H5P.html @@ -104,17 +104,16 @@ which require many different parameters to be easily manipulated.
  • H5Pget_istore_k - - -       - - File Close Properties + + +       +

    File Access Properties +
      +
      +
      +
      +
      +
      +
    +    ||   + Indicates functions
    +           + available only in the
    +           + parallel HDF5 library.     +        Dataset Creation Properties @@ -170,6 +183,11 @@ which require many different parameters to be easily manipulated. -->
  • H5Pset_fill_value
  • H5Pget_fill_value +
  • H5Pfill_value_defined +
  • H5Pset_fill_time +
  • H5Pget_fill_time +
  • H5Pset_alloc_time +
  • H5Pget_alloc_time
  • H5Pset_filter
  • H5Pget_nfilters
  • H5Pget_filter @@ -204,12 +222,6 @@ which require many different parameters to be easily manipulated.
  • H5Pget_small_data_block_size -
      -
    -||  Indicates functions
    -     available only in the
    -     parallel HDF5 library.     - + + + + +
    +
    +
    Name: H5Pset_fill_time +
    Signature: +
    herr_t H5Pset_fill_time(hid_t plist_id, + H5D_fill_time_t fill_time + ) +
    Purpose: +
    Sets the time when fill values are written to a dataset. +
    Description: +
    H5Pset_fill_time sets up the timing for writing fill values + to a dataset. + This property is set in the dataset creation property list plist_id. +

    + Timing is specified in fill_time with one of the following values: + +
         + H5D_FILL_TIME_ALLOC   + + Write fill values to the dataset when storage space is allocated. +   (Default) +
    + H5D_FILL_TIME_NEVER + + Never write fill values to the dataset. +
    +

    Note: +
    H5Pset_fill_time is designed for coordination + with the dataset fill value and + dataset storage allocation time properties, set with the functions + H5Pset_fill_value and H5Pset_alloc_time. +

    +

    Parameters: +
    +
    hid_t plist_id +
    IN: Dataset creation property list identifier. +
    H5D_fill_time_t fill_time +
    IN: When to write fill values to a dataset. +
    +
    Returns: +
    Returns a non-negative value if successful; + otherwise returns a negative value. + + +
    + + +
    +
    +
    Name: H5Pget_fill_time +
    Signature: +
    herr_t H5Pget_fill_time(hid_t plist_id, + H5D_fill_time_t *fill_time + ) +
    Purpose: +
    Retrieves the time when fill value are written to a dataset. +
    Description: +
    H5Pget_fill_time examines the dataset creation + property list plist_id to determine when fill values + are to be written to a dataset. +

    + Valid values returned in fill_time are as follows: + +
         + H5D_FILL_TIME_ALLOC   + + Fill values are written to the dataset when storage space is allocated. +   (Default) +
    + H5D_FILL_TIME_NEVER + + Fill values are never written to the dataset. +
    +

    Note: +
    H5Pget_fill_time is designed to work in coordination + with the dataset fill value and + dataset storage allocation time properties, retrieved with the functions + H5Pget_fill_value and H5Pget_alloc_time. +

    +

    Parameters: +
    +
    hid_t plist_id +
    IN: Dataset creation property list identifier. +
    H5D_fill_time_t *fill_time +
    OUT: Setting for the timing of writing fill values to the dataset. +
    +
    Returns: +
    Returns a non-negative value if successful; + otherwise returns a negative value. + + +
    + + +
    +
    +
    Name: H5Pset_alloc_time +
    Signature: +
    herr_t H5Pset_alloc_time(hid_t plist_id, + H5D_alloc_time_t alloc_time + ) +
    Purpose: +
    Sets the timing for storage space allocation. +
    Description: +
    H5Pset_alloc_time sets up the timing for the allocation of + storage space for a dataset's raw data. + This property is set in the dataset creation property list + plist_id. +

    + Timing is specified in fill_time with one of the + following values: + +
         + H5D_ALLOC_TIME_DEFAULT   + + Allocate dataset storage space at the default time.
    + (Defaults differ by storage method.) +
    + H5D_ALLOC_TIME_EARLY + + Allocate all space when the dataset is created.
    + (Default for compact datasets.) +
    + H5D_ALLOC_TIME_INCR   + + Allocate space incrementally, as data is written to the dataset.
    + (Default for chunked storage datasets.) +
  • Chunked datasets: + Storage space allocation for each chunk is deferred until data + is written to the chunk. +
  • Contiguous datasets: + Incremental storage space allocation for contiguous data + is treated as late allocation. +
  • Compact datasets: + Incremental allocation is not allowed with compact datasets; + H5Pset_alloc_time will return an error. +
    • + H5D_ALLOC_TIME_LATE + + Allocate all space when data is first written to the dataset.
    + (Default for contiguous datasets.) +
    +

    Note: +
    H5Pset_alloc_time is designed to work in concert + with the dataset fill value and fill value write time properties, + set with the functions + H5Pset_fill_value and H5Pset_fill_time. +

    +

    Parameters: +
    +
    hid_t plist_id +
    IN: Dataset creation property list identifier. +
    H5D_alloc_time_t alloc_time +
    IN: When to allocate dataset storage space. +
    +
    Returns: +
    Returns a non-negative value if successful; + otherwise returns a negative value. + + +
    + + +
    +
    +
    Name: H5Pget_alloc_time +
    Signature: +
    herr_t H5Pget_alloc_time(hid_t plist_id, + H5D_alloc_time_t *alloc_time + ) +
    Purpose: +
    Retrieves the timing for storage space allocation. +
    Description: +
    H5Pget_alloc_time retrieves the timing for allocating + storage space for a dataset's raw data. + This property is set in the dataset creation property list + plist_id. +

    + The timing setting is returned in fill_time as one of the + following values: + +
         + H5D_ALLOC_TIME_DEFAULT   + + Uses the default allocation time, based on the dataset storage method.
    + See the fill_time description in + H5Pset_alloc_time for + default allocation times for various storage methods. +
    + H5D_ALLOC_TIME_EARLY + + All space is allocated when the dataset is created. +
    + H5D_ALLOC_TIME_INCR   + + Space is allocated incrementally as data is written to the dataset. +
    + H5D_ALLOC_TIME_LATE + + All space is allocated when data is first written to the dataset. +
    +

    Note: +
    H5Pget_alloc_time is designed to work in concert + with the dataset fill value and fill value write time properties, + set with the functions + H5Pget_fill_value and H5Pget_fill_time. +

    +

    Parameters: +
    +
    hid_t plist_id +
    IN: Dataset creation property list identifier. +
    H5D_alloc_time_t *alloc_time +
    IN: When to allocate dataset storage space. +
    +
    Returns: +
    Returns a non-negative value if successful; + otherwise returns a negative value. + + +
    + + + + + + +
    Name: H5Pset_filter @@ -6307,7 +6671,7 @@ And in this document, the Describes HDF5 Release 1.5, Unreleased Development Branch -Last modified: 20 March 2003 +Last modified: 28 March 2003 -- cgit v0.12