From 51f150a94590f3b495d32c44f6d507eb5a7565a0 Mon Sep 17 00:00:00 2001 From: mattjala <124107509+mattjala@users.noreply.github.com> Date: Fri, 19 Jan 2024 21:11:06 -0600 Subject: Update H5Fget_obj_count/ids docs to reflect dtype behavior (#3932) * Update H5Fget_obj_count/ids to reflect dtype behavior * Clarify comments on H5Fget_obj_ids --- doxygen/aliases | 2 +- src/H5Fpublic.h | 5 +++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/doxygen/aliases b/doxygen/aliases index c83302a..4eb1962 100644 --- a/doxygen/aliases +++ b/doxygen/aliases @@ -363,7 +363,7 @@ ALIASES += indexes="
#H5_INDEX_NAMELexicographic order on ALIASES += link_types="
#H5L_TYPE_HARDHard link
#H5L_TYPE_SOFTSoft link
#H5L_TYPE_EXTERNALExternal link
#H5L_TYPE_ERRORError
" ALIASES += mem_types="
#H5FD_MEM_DEFAULTThe default file memory allocation type
#H5FD_MEM_SUPERFile memory allocated for Superblock
#H5FD_MEM_BTREEFile memory allocated for B-tree
#H5FD_MEM_DRAWFile memory allocated for raw data
#H5FD_MEM_GHEAPFile memory allocated for Global Heap
#H5FD_MEM_LHEAPFile memory allocated for Local Heap
#H5FD_MEM_OHDRFile memory allocated for Object Header
" ALIASES += norm_type="
#H5T_NORM_IMPLIED0MSB of mantissa is not stored, always 1
#H5T_NORM_MSBSET1MSB of mantissa is always 1
#H5T_NORM_NONE2Mantissa is not normalized
" -ALIASES += obj_types="
#H5F_OBJ_FILEFiles only
#H5F_OBJ_DATASETDatasets only
#H5F_OBJ_GROUPGroups only
#H5F_OBJ_DATATYPENamed datatypes only
#H5F_OBJ_ATTRAttributes only
#H5F_OBJ_ALLAll of the above
#H5F_OBJ_LOCALRestrict search to objects opened through current file identifier.
\attention #H5F_OBJ_LOCAL does not stand alone; it is effective only when used in combination with one or more of the preceding types. For example, #H5F_OBJ_DATASET | #H5F_OBJ_GROUP | #H5F_OBJ_LOCAL would count all datasets and groups opened through the current file identifier." +ALIASES += obj_types="
#H5F_OBJ_FILEFiles only
#H5F_OBJ_DATASETDatasets only
#H5F_OBJ_GROUPGroups only
#H5F_OBJ_DATATYPEDatatypes only. If \p file_id is #H5F_OBJ_ALL, this will count committed and transient datatypes. Otherwise, it will only count committed datatypes.
#H5F_OBJ_ATTRAttributes only
#H5F_OBJ_ALLAll of the above
#H5F_OBJ_LOCALRestrict search to objects opened through current file identifier.
\attention #H5F_OBJ_LOCAL does not stand alone; it is effective only when used in combination with one or more of the preceding types. For example, #H5F_OBJ_DATASET | #H5F_OBJ_GROUP | #H5F_OBJ_LOCAL would count all datasets and groups opened through the current file identifier." ALIASES += orders="
#H5_ITER_INCIncreasing order
#H5_ITER_DECDecreasing order
#H5_ITER_NATIVEFastest available order
" ALIASES += padding_type="
#H5T_PAD_ZERO0Set background to zeros
#H5T_PAD_ONE1Set background to ones
#H5T_PAD_BACKGROUND2Leave background alone
" ALIASES += scopes="
#H5F_SCOPE_GLOBALFlushes the entire virtual file
#H5F_SCOPE_LOCALFlushes only the specified file
" diff --git a/src/H5Fpublic.h b/src/H5Fpublic.h index adb272e..6db1c71 100644 --- a/src/H5Fpublic.h +++ b/src/H5Fpublic.h @@ -75,7 +75,7 @@ #define H5F_OBJ_FILE (0x0001u) /**< File objects */ #define H5F_OBJ_DATASET (0x0002u) /**< Dataset objects */ #define H5F_OBJ_GROUP (0x0004u) /**< Group objects */ -#define H5F_OBJ_DATATYPE (0x0008u) /**< Named datatype objects */ +#define H5F_OBJ_DATATYPE (0x0008u) /**< Datatype objects */ #define H5F_OBJ_ATTR (0x0010u) /**< Attribute objects */ #define H5F_OBJ_ALL (H5F_OBJ_FILE | H5F_OBJ_DATASET | H5F_OBJ_GROUP | H5F_OBJ_DATATYPE | H5F_OBJ_ATTR) #define H5F_OBJ_LOCAL \ @@ -761,7 +761,8 @@ H5_DLL herr_t H5Fget_fileno(hid_t file_id, unsigned long *fileno); * object identifiers for the file. * * To retrieve a count of open identifiers for open objects in all - * HDF5 application files that are currently open, pass the value + * HDF5 application files that are currently open, as well as transient + * datatype objects that are not associated with any file, pass the value * #H5F_OBJ_ALL in \p file_id. * * The types of objects to be counted are specified in types as -- cgit v0.12