diff options
author | Gerd Heber <gheber@hdfgroup.org> | 2021-12-09 16:32:00 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-12-09 16:32:00 (GMT) |
commit | dab3838a635b9816940c4fa03b3185c37abab3e5 (patch) | |
tree | dca96b9d047b3b3d2b0eb2b8222e5883d2d66630 /src/H5Ppublic.h | |
parent | 2b4c2d9c7163274ad6008e701413edfd10f88b3b (diff) | |
download | hdf5-dab3838a635b9816940c4fa03b3185c37abab3e5.zip hdf5-dab3838a635b9816940c4fa03b3185c37abab3e5.tar.gz hdf5-dab3838a635b9816940c4fa03b3185c37abab3e5.tar.bz2 |
Fixed minor issues. (#1259)
* Fixed minor issues.
* Committing clang-format changes
* Fixed CMake.
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Diffstat (limited to 'src/H5Ppublic.h')
-rw-r--r-- | src/H5Ppublic.h | 111 |
1 files changed, 100 insertions, 11 deletions
diff --git a/src/H5Ppublic.h b/src/H5Ppublic.h index 2cac8b8..962552f 100644 --- a/src/H5Ppublic.h +++ b/src/H5Ppublic.h @@ -11,6 +11,103 @@ * help@hdfgroup.org. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ +/**\defgroup H5P H5P + * + * Use the functions in this module to manage HDF5 property lists and property + * list classes. HDF5 property lists are the main vehicle to configure the + * behavior of HDF5 API functions. + * + * Typically, property lists are created by instantiating one of the built-in + * or user-defined property list classes. After adding suitable properties, + * property lists are used when opening or creating HDF5 items, or when reading + * or writing data. Property lists can be modified by adding or changing + * properties. Property lists are deleted by closing the associated handles. + * + * \defgroup ALCAPL Attribute and Link Creation Properties + * \ingroup H5P + * Currently, there are only two creation properties that you can use to control + * the creation of HDF5 attributes and links. The first creation property, the + * choice of a character encoding, applies to both attributes and links. + * The second creation property applies to links only, and advises the library + * to automatically create missing intermediate groups when creating new objects. + * + * \defgroup DAPL Dataset Access Properties + * \ingroup H5P + * Use dataset access properties to modify the default behavior of the HDF5 + * library when accessing datasets. The properties include adjusting the size + * of the chunk cache, providing prefixes for external content and virtual + * dataset file paths, and controlling flush behavior, etc. These properties + * are \Emph{not} persisted with datasets, and can be adjusted at runtime before + * a dataset is created or opened. + * + * \defgroup DCPL Dataset Creation Properties + * \ingroup H5P + * Use dataset creation properties to control aspects of dataset creation such + * as fill time, storage layout, compression methods, etc. + * Unlike dataset access and transfer properties, creation properties \Emph{are} + * stored with the dataset, and cannot be changed once a dataset has been + * created. + * + * \defgroup DXPL Dataset Transfer Properties + * \ingroup H5P + * Use dataset transfer properties to customize certain aspects of reading + * and writing datasets such as transformations, MPI-IO I/O mode, error + * detection, etc. These properties are \Emph{not} persisted with datasets, + * and can be adjusted at runtime before a dataset is read or written. + * + * \defgroup FAPL File Access Properties + * \ingroup H5P + * Use file access properties to modify the default behavior of the HDF5 + * library when accessing files. The properties include selecting a virtual + * file driver (VFD), configuring the metadata cache (MDC), control + * file locking, etc. These properties are \Emph{not} persisted with files, and + * can be adjusted at runtime before a file is created or opened. + * + * \defgroup FCPL File Creation Properties + * \ingroup H5P + * Use file creation properties to control aspects of file creation such + * as setting a file space management strategy or creating a user block. + * Unlike file access properties, creation properties \Emph{are} + * stored with the file, and cannot be changed once a file has been + * created. + * + * \defgroup GAPL General Access Properties + * \ingroup H5P + * \todo Should this be as standalone page? + * + * \defgroup GCPL Group Creation Properties + * \ingroup H5P + * Use group creation properties to control aspects of group creation such + * as storage layout, compression, and link creation order tracking. + * Unlike file access properties, creation properties \Emph{are} + * stored with the group, and cannot be changed once a group has been + * created. + * + * \defgroup GPLO General Property List Operations + * \ingroup H5P + * + * Use the functions in this module to manage HDF5 property lists. + * + * \defgroup GPLOA General Property List Operations (Advanced) + * \ingroup H5P + * + * You can create and customize user-defined property list classes using the + * functions described below. Arbitrary user-defined properties can also + * be inserted into existing property lists as so-called temporary properties. + * + * \defgroup LAPL Link Access Properties + * \ingroup H5P + * + * \defgroup MAPL Map Access Properties + * \ingroup H5P + * \defgroup OCPL Object Creation Properties + * \ingroup H5P + * + * \defgroup OCPPL Object Copy Properties + * \ingroup H5P + * + */ + /* * This file contains function prototypes for each exported function in the * H5P module. @@ -3572,10 +3669,8 @@ H5_DLL herr_t H5Pget_small_data_block_size(hid_t fapl_id, hsize_t *size /*out*/) * the file. For MPI IO and other parallel systems, choose an * alignment which is a multiple of the disk block size. * - * If the file space handling strategy is set to - * #H5F_FSPACE_STRATEGY_PAGE, then the alignment set via this - * routine is ignored. The file space handling strategy is set - * by H5Pset_file_space_strategy(). + * The file space handling strategy is set by + * H5Pset_file_space_strategy(). * * \since 1.0.0 * @@ -4690,8 +4785,6 @@ H5_DLL herr_t H5Pget_fill_value(hid_t plist_id, hid_t type_id, void *value /*out * - #H5D_CHUNKED: Raw data is stored separately from the object * header in chunks in separate locations in the * file. - * - #H5D_VIRTUAL: Raw data is drawn from multiple datasets in - * different files. * \return * Otherwise, returns a negative value indicating failure. * @@ -4703,8 +4796,6 @@ H5_DLL herr_t H5Pget_fill_value(hid_t plist_id, hid_t type_id, void *value /*out * the dataset with parallel applications. See the H5Dwrite() * documentation for details. * - * \version 1.10.0 #H5D_VIRTUAL added in this release. - * * \since 1.0.0 * */ @@ -5007,13 +5098,11 @@ H5_DLL herr_t H5Pset_shuffle(hid_t plist_id); * - #H5D_CHUNKED: Store raw data separately from the object header * as chunks of data in separate locations in * the file. - * - #H5D_VIRTUAL: Draw raw data from multiple datasets in - * different files. * * Note that a compact storage layout may affect writing data to * the dataset with parallel applications. See the note in * H5Dwrite() documentation for details. - * \version 1.10.0 #H5D_VIRTUAL added in this release. + * * \since 1.0.0 * */ |