From 331d3d504d053bcc91d62e836e36bc0462500568 Mon Sep 17 00:00:00 2001 From: Frank Baker Date: Thu, 26 Jun 2003 11:50:00 -0500 Subject: [svn-r7111] Purpose: Primarily edits from technical review. Description: H5Pget_fill_value -- Corrected 'value' parameter type. H5Pget_fill_time -- Added H5D_FILL_TIME_IFSET. H5Pset_filter --Add that filters are applied to chunks in order in which they were created. Correct H5Z_FLAG_OPTIONAL description. Add references to related functions. Add H5Z_FILTER_SZIP to list of valid filters. H5Pget_filter -- Add H5Z_FILTER_SZIP to list of possible filters. H5Pset_szip -- Remove list of publications references. H5Pset_edc_check -- Reverse notation of default setting. Copy edits. Platforms tested: IE 5, Safari --- doc/html/RM_H5P.html | 46 ++++++++++++++++++++++++++++++++++++---------- 1 file changed, 36 insertions(+), 10 deletions(-) diff --git a/doc/html/RM_H5P.html b/doc/html/RM_H5P.html index 16172bb..69da68d 100644 --- a/doc/html/RM_H5P.html +++ b/doc/html/RM_H5P.html @@ -3031,7 +3031,7 @@ facilitate moving easily between them. that the fill value is to be undefined.
Notes:
Applications sometimes write data only to portions of - an allcoated dataset. It is often useful in such cases + an allocated dataset. It is often useful in such cases to fill the unused space with a known fill value. This function allows the user application to set that fill value; @@ -3125,7 +3125,7 @@ facilitate moving easily between them.
hid_t type_id,
IN: Datatype identifier for the value passed via value. -
const void *value +
void *value
OUT: Pointer to buffer to contain the returned fill value.
Returns: @@ -3276,12 +3276,18 @@ facilitate moving easily between them.

Valid values returned in fill_time are as follows: - + This flag should not be set for the Fletcher32 checksum + filter as it will bypass the checksum filter without + reporting checksum errors to an application.
     +
     + H5D_FILL_TIME_IFSET   + + Fill values are written to the dataset when storage space is allocated + only if there is a user-defined fill value, i.e., one set with + H5Pset_fill_value. +   (Default) +
  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. @@ -3504,7 +3510,9 @@ facilitate moving easily between them. clear and a filter fails, then H5Dwrite or H5Dread also fails.

- This flag is mandatory for the Fletcher32 checksum filter.
@@ -3529,13 +3537,24 @@ facilitate moving easily between them. Error detection filter, employing the Fletcher32 checksum algorithm + + H5Z_FILTER_SZIP + + Data compression filter, employing the SZIP algorithm + +

+ Also see H5Pset_edc_check and + H5Pset_filter_callback. -

Note: +
Notes:
This function currently supports only the permanent filter pipeline; plist must be a dataset creation property list. +

+ If multiple filters are set for a property list, they will be + applied to each chunk in the order in which they were set.

Parameters:
hid_t plist @@ -3723,6 +3742,11 @@ facilitate moving easily between them. Error detection filter, employing the Fletcher32 checksum algorithm + + H5Z_FILTER_SZIP + + Data compression filter, employing the SZIP algorithm + Otherwise returns a negative value. @@ -4091,6 +4115,7 @@ facilitate moving easily between them. --> +
@@ -4163,9 +4189,9 @@ facilitate moving easily between them. Valid values are as follows:
       - H5Z_ENABLE_EDC + H5Z_ENABLE_EDC   (default)
- H5Z_DISABLE_EDC   (default) + H5Z_DISABLE_EDC

@@ -7607,7 +7633,7 @@ And in this document, the Describes HDF5 Release 1.5, Unreleased Development Branch -Last modified: 23 June 2003 +Last modified: 25 June 2003 -- cgit v0.12