diff options
Diffstat (limited to 'src/H5Dpublic.h')
-rw-r--r-- | src/H5Dpublic.h | 147 |
1 files changed, 145 insertions, 2 deletions
diff --git a/src/H5Dpublic.h b/src/H5Dpublic.h index 00948f9..8d0ef30 100644 --- a/src/H5Dpublic.h +++ b/src/H5Dpublic.h @@ -140,7 +140,7 @@ extern "C" { * \brief Creates a new dataset and links it into the file * * \fgdta_loc_id - * \param[in] name Name of the dataset to open + * \param[in] name Name of the dataset to create * \type_id * \space_id * \lcpl_id @@ -149,7 +149,6 @@ extern "C" { * * \return \hid_t{dataset} * - * * \details H5Dcreate2() creates a new dataset named \p name at * the location specified by \p loc_id, and associates constant * and initial persistent properties with that dataset, including @@ -201,6 +200,30 @@ extern "C" { */ H5_DLL hid_t H5Dcreate2(hid_t loc_id, const char *name, hid_t type_id, hid_t space_id, hid_t lcpl_id, hid_t dcpl_id, hid_t dapl_id); + +/** + * -------------------------------------------------------------------------- + * \ingroup H5D + * + * \brief Asynchronous version of H5Dcreate2() + * + * \app_file + * \app_func + * \app_line + * \fgdta_loc_id + * \param[in] name Name of the dataset to create + * \type_id + * \space_id + * \lcpl_id + * \dcpl_id + * \dapl_id + * \es_id + * + * \return \hid_t{dataset} + * + * \see H5Dcreate2() + * + */ H5_DLL hid_t H5Dcreate_async(const char *app_file, const char *app_func, unsigned app_line, hid_t loc_id, const char *name, hid_t type_id, hid_t space_id, hid_t lcpl_id, hid_t dcpl_id, hid_t dapl_id, hid_t es_id); @@ -299,6 +322,26 @@ H5_DLL hid_t H5Dcreate_anon(hid_t loc_id, hid_t type_id, hid_t space_id, hid_t * */ H5_DLL hid_t H5Dopen2(hid_t loc_id, const char *name, hid_t dapl_id); + +/** + * -------------------------------------------------------------------------- + * \ingroup H5D + * + * \brief Asynchronous version of H5Dopen2() + * + * \app_file + * \app_func + * \app_line + * \fgdta_loc_id + * \param[in] name Name of the dataset to open + * \dapl_id + * \es_id + * + * \return \hid_t{dataset} + * + * \see H5Dopen2() + * + */ H5_DLL hid_t H5Dopen_async(const char *app_file, const char *app_func, unsigned app_line, hid_t loc_id, const char *name, hid_t dapl_id, hid_t es_id); @@ -324,6 +367,24 @@ H5_DLL hid_t H5Dopen_async(const char *app_file, const char *app_func, unsigned * */ H5_DLL hid_t H5Dget_space(hid_t dset_id); + +/** + * -------------------------------------------------------------------------- + * \ingroup H5D + * + * \brief Asynchronous version of H5Dget_space() + * + * \app_file + * \app_func + * \app_line + * \dset_id + * \es_id + * + * \return \hid_t{dataspace} + * + * \see H5Dget_space() + * + */ H5_DLL hid_t H5Dget_space_async(const char *app_file, const char *app_func, unsigned app_line, hid_t dset_id, hid_t es_id); @@ -732,6 +793,28 @@ H5_DLL haddr_t H5Dget_offset(hid_t dset_id); H5_DLL herr_t H5Dread(hid_t dset_id, hid_t mem_type_id, hid_t mem_space_id, hid_t file_space_id, hid_t dxpl_id, void *buf /*out*/); +/** + * -------------------------------------------------------------------------- + * \ingroup H5D + * + * \brief Asynchronous version of H5Dread() + * + * \app_file + * \app_func + * \app_line + * \dset_id Identifier of the dataset to read from + * \param[in] mem_type_id Identifier of the memory datatype + * \param[in] mem_space_id Identifier of the memory dataspace + * \param[in] file_space_id Identifier of the dataset's dataspace in the file + * \param[in] dxpl_id Identifier of a transfer property list + * \param[out] buf Buffer to receive data read from file + * \es_id + * + * \return \herr_t + * + * \see H5Dread() + * + */ H5_DLL herr_t H5Dread_async(const char *app_file, const char *app_func, unsigned app_line, hid_t dset_id, hid_t mem_type_id, hid_t mem_space_id, hid_t file_space_id, hid_t dxpl_id, void *buf /*out*/, hid_t es_id); @@ -847,6 +930,28 @@ H5_DLL herr_t H5Dread_async(const char *app_file, const char *app_func, unsigne H5_DLL herr_t H5Dwrite(hid_t dset_id, hid_t mem_type_id, hid_t mem_space_id, hid_t file_space_id, hid_t dxpl_id, const void *buf); +/** + * -------------------------------------------------------------------------- + * \ingroup H5D + * + * \brief Asynchronous version of H5Dwrite() + * + * \app_file + * \app_func + * \app_line + * \param[in] dset_id Identifier of the dataset to read from + * \param[in] mem_type_id Identifier of the memory datatype + * \param[in] mem_space_id Identifier of the memory dataspace + * \param[in] file_space_id Identifier of the dataset's dataspace in the file + * \dxpl_id + * \param[out] buf Buffer with data to be written to the file + * \es_id + * + * \return \herr_t + * + * \see H5Dwrite() + * + */ H5_DLL herr_t H5Dwrite_async(const char *app_file, const char *app_func, unsigned app_line, hid_t dset_id, hid_t mem_type_id, hid_t mem_space_id, hid_t file_space_id, hid_t dxpl_id, const void *buf, hid_t es_id); @@ -1184,6 +1289,26 @@ H5_DLL herr_t H5Dfill(const void *fill, hid_t fill_type_id, void *buf, hid_t bu * */ H5_DLL herr_t H5Dset_extent(hid_t dset_id, const hsize_t size[]); + +/** + * -------------------------------------------------------------------------- + * \ingroup H5D + * + * \brief Asynchronous version of H5Dset_extent() + * + * \app_file + * \app_func + * \app_line + * \dset_id + * \param[in] size[] Array containing the new magnitude of each dimension + * of the dataset + * \es_id + * + * \return \herr_t + * + * \see H5Dset_extent() + * + */ H5_DLL herr_t H5Dset_extent_async(const char *app_file, const char *app_func, unsigned app_line, hid_t dset_id, const hsize_t size[], hid_t es_id); @@ -1408,6 +1533,24 @@ H5_DLL herr_t H5Dgather(hid_t src_space_id, const void *src_buf, hid_t type_id, * */ H5_DLL herr_t H5Dclose(hid_t dset_id); + +/** + * -------------------------------------------------------------------------- + * \ingroup H5D + * + * \brief Asynchronous version of H5Dclose() + * + * \app_file + * \app_func + * \app_line + * \dset_id + * \es_id + * + * \return \herr_t + * + * \see H5Dclose() + * + */ H5_DLL herr_t H5Dclose_async(const char *app_file, const char *app_func, unsigned app_line, hid_t dset_id, hid_t es_id); |