![]() |
HDF5 Last Updated on 2025-12-16
The HDF5 Field Guide
|
#include <c++/src/H5FaccProp.h>
Class FileAccPropList inherits from PropList and provides wrappers for the HDF5 file access property list.
Inheritance diagram for FileAccPropList:Public Member Functions | |
| FileAccPropList () | |
| Creates a file access property list. | |
| FileAccPropList (const FileAccPropList &original) | |
| Copy constructor: same HDF5 object as original. | |
| FileAccPropList (const hid_t plist_id) | |
| Creates a file access property list using the id of an existing one. | |
| virtual std::string | fromClass () const override |
| Returns this class name. | |
| void | getAlignment (hsize_t &threshold, hsize_t &alignment) const |
| Returns the current settings for alignment properties from this property list. | |
| void | getCache (int &mdc_nelmts, size_t &rdcc_nelmts, size_t &rdcc_nbytes, double &rdcc_w0) const |
| Queries the meta data cache and raw data chunk cache parameters. | |
| void | getCore (size_t &increment, bool &backing_store) const |
| Queries core file driver properties. | |
| hid_t | getDriver () const |
| Return the ID of the low-level file driver. | |
| FileAccPropList | getFamily (hsize_t &memb_size) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts and its return value. | |
| void | getFamily (hsize_t &memb_size, FileAccPropList &memb_plist) const |
| Returns information about the family file access property list. | |
| hsize_t | getFamilyOffset () const |
| Get offset for family driver. | |
| H5F_close_degree_t | getFcloseDegree () const |
| Returns the degree for the file close behavior. | |
| void | getFileAccDirect (size_t &boundary, size_t &block_size, size_t &cbuf_size) const |
| void | getFileLocking (bool &use_file_locking, bool &ignore_when_disabled) const |
| Gets file locking flags. | |
| unsigned | getGcReferences () const |
| Returns the garbage collecting references setting. | |
| void | getLibverBounds (H5F_libver_t &libver_low, H5F_libver_t &libver_high) const |
| Gets the current settings for the library version format bounds from a file access property list. | |
| hsize_t | getMetaBlockSize () const |
| Returns the current metadata block size setting. | |
| H5FD_mem_t | getMultiType () const |
Returns the data type property for MULTI driver. | |
| size_t | getSieveBufSize () const |
| Returns the current settings for the data sieve buffer size property from this property list. | |
| void | setAlignment (hsize_t threshold=1, hsize_t alignment=1) const |
| Sets the alignment properties of this property list. | |
| void | setCache (int mdc_nelmts, size_t rdcc_nelmts, size_t rdcc_nbytes, double rdcc_w0) const |
| Sets the meta data cache and raw data chunk cache parameters. | |
| void | setCore (size_t increment, bool backing_store) const |
Modifies this file access property list to use the H5FD_CORE driver. | |
| void | setDriver (hid_t new_driver_id, const void *new_driver_info) const |
| Set file driver for this property list. | |
| void | setFamily (hsize_t memb_size, const FileAccPropList &memb_plist) const |
| Sets this file access property list to use the family driver. | |
| void | setFamilyOffset (hsize_t offset) const |
| Sets offset for family driver. | |
| void | setFcloseDegree (H5F_close_degree_t degree) const |
| Sets the degree for the file close behavior. | |
| void | setFileAccDirect (size_t boundary, size_t block_size, size_t cbuf_size) const |
| void | setFileLocking (bool use_file_locking, bool ignore_when_disabled) const |
| Sets file locking flags. | |
| void | setGcReferences (unsigned gc_ref=0) const |
| Sets garbage collecting references flag. | |
| void | setLibverBounds (H5F_libver_t libver_low, H5F_libver_t libver_high) const |
| Sets bounds on versions of library format to be used when creating or writing objects. | |
| void | setLog (const char *logfile, unsigned flags, size_t buf_size) const |
| Modifies this file access property list to use the logging driver. | |
| void | setLog (const std::string &logfile, unsigned flags, size_t buf_size) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. | |
| void | setMetaBlockSize (hsize_t &block_size) const |
| Sets the minimum size of metadata block allocations. | |
| void | setMultiType (H5FD_mem_t dtype) const |
Sets data type for MULTI driver. | |
| void | setSec2 () const |
| Modifies this file access property list to use the sec2 driver. | |
| void | setSieveBufSize (size_t bufsize) const |
| Sets the maximum size of the data sieve buffer. | |
| void | setSplit (const FileAccPropList &meta_plist, const FileAccPropList &raw_plist, const char *meta_ext=".meta", const char *raw_ext=".raw") const |
| Emulates the old split file driver, which stored meta data in one file and raw data in another file. | |
| void | setSplit (const FileAccPropList &meta_plist, const FileAccPropList &raw_plist, const std::string &meta_ext=".meta", const std::string &raw_ext=".raw") const |
This is an overloaded member function, provided for convenience. It takes character arguments as H5std_string. | |
| void | setStdio () const |
Modifies this property list to use the H5FD_STDIO driver. | |
| virtual | ~FileAccPropList () override=default |
Public Member Functions inherited from PropList | |
| virtual void | close () override |
| Closes the property list if it is not a default one. | |
| void | closeClass () const |
| Close a property list class. | |
| void | copy (const PropList &like_plist) |
| Makes a copy of an existing property list. | |
| void | copyProp (PropList &dest, const char *name) const |
| Copies a property from this property list or class to another. | |
| void | copyProp (PropList &dest, const std::string &name) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. | |
| void | copyProp (PropList &dest, PropList &src, const char *name) const |
| Copies a property from one list or class to another - Obsolete. | |
| void | copyProp (PropList &dest, PropList &src, const std::string &name) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. - Obsolete. | |
| hid_t | getClass () const |
Returns the class of this property list, i.e. H5P_FILE_CREATE... | |
| std::string | getClassName () const |
| Return the name of a generic property list class. | |
| PropList | getClassParent () const |
| Returns the parent class of a generic property class. | |
| virtual hid_t | getId () const override |
| Get the id of this property list. | |
| size_t | getNumProps () const |
| Returns the number of properties in this property list or class. | |
| std::string | getProperty (const char *name) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. | |
| void | getProperty (const char *name, void *value) const |
| Query the value of a property in a property list. | |
| std::string | getProperty (const std::string &name) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. | |
| void | getProperty (const std::string &name, void *value) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. | |
| size_t | getPropSize (const char *name) const |
| Query the size of a property in a property list or class. | |
| size_t | getPropSize (const std::string &name) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. | |
| bool | isAClass (const PropList &prop_class) const |
| Determines whether a property list is a certain class. | |
| PropList & | operator= (const PropList &rhs) |
| Assignment operator. | |
| bool | operator== (const PropList &rhs) const |
| Compares this property list or class against the given list or class. | |
| bool | propExist (const char *name) const |
| Query the existence of a property in a property object. | |
| bool | propExist (const std::string &name) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. | |
| PropList () | |
| Default constructor: creates a stub property list object. | |
| PropList (const hid_t plist_id) | |
| Creates a property list using the id of an existing property. | |
| PropList (const PropList &original) | |
| Copy constructor: same HDF5 object as original. | |
| void | removeProp (const char *name) const |
| Removes a property from a property list. | |
| void | removeProp (const std::string &name) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. | |
| void | setProperty (const char *name, const char *charptr) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. | |
| void | setProperty (const char *name, const std::string &strg) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. | |
| void | setProperty (const char *name, const void *value) const |
| Set a property's value in a property list. | |
| void | setProperty (const char *name, std::string &strg) const |
| Deprecated due to missing const in prototype. (1.10.1) | |
| void | setProperty (const char *name, void *value) const |
| Deprecated due to missing const in prototype. (1.10.1) | |
| void | setProperty (const std::string &name, const std::string &strg) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. | |
| void | setProperty (const std::string &name, const void *value) const |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. | |
| void | setProperty (const std::string &name, std::string &strg) const |
| Deprecated due to missing const in prototype. (1.10.1) | |
| void | setProperty (const std::string &name, void *value) const |
| Deprecated due to missing const in prototype. (1.10.1) | |
| virtual | ~PropList () override |
| Properly terminates access to this property list. | |
Public Member Functions inherited from IdComponent | |
| void | decRefCount () const |
| Decrement reference counter for the id of this object. | |
| void | decRefCount (const hid_t obj_id) const |
| Decrement reference counter for a given id. | |
| int | getCounter () const |
| Returns the reference counter for the id of this object. | |
| int | getCounter (const hid_t obj_id) const |
| Returns the reference counter for a given id. | |
| H5I_type_t | getHDFObjType () const |
| Returns the type of the object. It is an overloaded function of the above function. | |
| void | incRefCount () const |
| Increment reference counter for the id of this object. | |
| void | incRefCount (const hid_t obj_id) const |
| Increment reference counter for a given id. | |
| std::string | inMemFunc (const char *func_name) const |
| Makes and returns string "<class-name>::<func_name>". | |
| IdComponent & | operator= (const IdComponent &rhs) |
| Assignment operator. | |
| void | setId (const hid_t new_id) |
| Sets the identifier of this object to a new value. | |
| virtual | ~IdComponent ()=default |
Static Public Member Functions | |
| static void | deleteConstants () |
Static Public Member Functions inherited from PropList | |
| static void | deleteConstants () |
Static Public Member Functions inherited from IdComponent | |
| static H5I_type_t | getHDFObjType (const hid_t obj_id) |
| Given an id, returns the type of the object. | |
| static hsize_t | getNumMembers (H5I_type_t type) |
| Returns the number of members of the given type. | |
| static bool | isValid (hid_t an_id) |
| Checks if the given ID is valid. | |
| static bool | typeExists (H5I_type_t type) |
| Queries if a given type is currently registered with the library. | |
Static Public Attributes | |
| static const FileAccPropList & | DEFAULT = *getConstant() |
| Default file access property list. | |
Static Public Attributes inherited from PropList | |
| static const PropList & | DEFAULT = *getConstant() |
| Default property list. | |
Additional Inherited Members | |
Protected Member Functions inherited from PropList | |
| virtual void | p_setId (const hid_t new_id) override |
| Sets the identifier of this object to a new value. | |
Protected Member Functions inherited from IdComponent | |
| IdComponent () | |
| Default constructor. | |
| std::string | p_get_file_name () const |
Static Protected Member Functions inherited from IdComponent | |
| static bool | p_valid_id (const hid_t obj_id) |
Protected Attributes inherited from PropList | |
| hid_t | id |
Static Protected Attributes inherited from IdComponent | |
| static bool | H5dontAtexit_called = false |
| FileAccPropList | ( | ) |
Creates a file access property list.
| FileAccPropList | ( | const FileAccPropList & | original | ) |
Copy constructor: same HDF5 object as original.
| original | - IN: FileAccPropList instance to copy |
| FileAccPropList | ( | const hid_t | plist_id | ) |
Creates a file access property list using the id of an existing one.
|
overridevirtualdefault |
|
static |
|
overridevirtual |
Returns this class name.
Reimplemented from PropList.
Returns the current settings for alignment properties from this property list.
| threshold | - OUT: Retrieved threshold value for file object size |
| alignment | - OUT: Retrieved alignment value |
| H5::PropListIException |
| void getCache | ( | int & | mdc_nelmts, |
| size_t & | rdcc_nelmts, | ||
| size_t & | rdcc_nbytes, | ||
| double & | rdcc_w0 ) const |
Queries the meta data cache and raw data chunk cache parameters.
| mdc_nelmts | - OUT: Number of elements in the meta data cache |
| rdcc_nelmts | - OUT: Number of elements in the raw data chunk cache |
| rdcc_nbytes | - OUT: Total size of the raw data chunk cache, in bytes |
| rdcc_w0 | - OUT: Preemption policy |
| H5::PropListIException |
| void getCore | ( | size_t & | increment, |
| bool & | backing_store ) const |
Queries core file driver properties.
| increment | - OUT: Size of memory increment, in bytes |
| backing_store | - OUT: Indicating whether to write the file contents to disk when the file is closed |
| H5::PropListIException |
| hid_t getDriver | ( | ) | const |
Return the ID of the low-level file driver.
| H5::PropListIException |
| FileAccPropList getFamily | ( | hsize_t & | memb_size | ) | const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts and its return value.
| memb_size | - OUT: Size in bytes of each file member |
| H5::PropListIException |
| void getFamily | ( | hsize_t & | memb_size, |
| FileAccPropList & | memb_plist ) const |
Returns information about the family file access property list.
| memb_size | - OUT: Size in bytes of each file member |
| memb_plist | - OUT: Retrieved file access property list for each file member |
| H5::PropListIException |
| hsize_t getFamilyOffset | ( | ) | const |
| H5F_close_degree_t getFcloseDegree | ( | ) | const |
Returns the degree for the file close behavior.
| H5::PropListIException |
| void getFileAccDirect | ( | size_t & | boundary, |
| size_t & | block_size, | ||
| size_t & | cbuf_size ) const |
| void getFileLocking | ( | bool & | use_file_locking, |
| bool & | ignore_when_disabled ) const |
Gets file locking flags.
| use_file_locking | - OUT: Flag that determines if file locks |
| ignore_when_disabled | - OUT: Flag that determines if file locks |
| H5::PropListIException |
| unsigned getGcReferences | ( | ) | const |
Returns the garbage collecting references setting.
| H5::PropListIException |
| void getLibverBounds | ( | H5F_libver_t & | libver_low, |
| H5F_libver_t & | libver_high ) const |
Gets the current settings for the library version format bounds from a file access property list.
| libver_low | - OUT: Earliest version of the library that will be used for creating or writing objects |
| libver_high | - OUT: Latest version of the library that will be used for creating or writing objects |
| H5::PropListIException |
H5F_LIBVER_EARLIEST H5F_LIBVER_18 H5F_LIBVER_110 H5F_LIBVER_112 H5F_LIBVER_114 H5F_LIBVER_200 H5F_LIBVER_LATEST H5F_LIBVER_18 H5F_LIBVER_110 H5F_LIBVER_112 H5F_LIBVER_114 H5F_LIBVER_200 H5F_LIBVER_LATEST | hsize_t getMetaBlockSize | ( | ) | const |
Returns the current metadata block size setting.
| H5::PropListIException |
| H5FD_mem_t getMultiType | ( | ) | const |
Returns the data type property for MULTI driver.
| H5::PropListIException |
| size_t getSieveBufSize | ( | ) | const |
Returns the current settings for the data sieve buffer size property from this property list.
| H5::PropListIException |
Sets the alignment properties of this property list.
| threshold | - IN: Threshold value for file object size |
| alignment | - IN: Alignment value |
| H5::PropListIException |
For more detail, please refer to the H5Pset_alignment API in the HDF5 C Reference Manual.
| void setCache | ( | int | mdc_nelmts, |
| size_t | rdcc_nelmts, | ||
| size_t | rdcc_nbytes, | ||
| double | rdcc_w0 ) const |
Sets the meta data cache and raw data chunk cache parameters.
| mdc_nelmts | - IN: Number of elements in the meta data cache |
| rdcc_nelmts | - IN: Number of elements in the raw data chunk cache |
| rdcc_nbytes | - IN: Total size of the raw data chunk cache, in bytes |
| rdcc_w0 | - IN: Preemption policy |
| H5::PropListIException |
| void setCore | ( | size_t | increment, |
| bool | backing_store ) const |
Modifies this file access property list to use the H5FD_CORE driver.
| increment | - IN: Specifies how much memory to increase each time more memory is needed, in bytes |
| backing_store | - IN: Indicating whether to write the file contents to disk when the file is closed |
| H5::PropListIException |
H5FD_CORE driver, please refer to the H5Pset_fapl_core API in the HDF5 C Reference Manual. | void setDriver | ( | hid_t | new_driver_id, |
| const void * | new_driver_info ) const |
Set file driver for this property list.
| new_driver_id | - IN: File driver |
| new_driver_info | - IN: Struct containing the driver-specific properties |
| H5::PropListIException |
| void setFamily | ( | hsize_t | memb_size, |
| const FileAccPropList & | memb_plist ) const |
Sets this file access property list to use the family driver.
| memb_size | - IN: Size in bytes of each file member |
| memb_plist | - IN: File access property list to be used for each family member |
| H5::PropListIException |
| void setFamilyOffset | ( | hsize_t | offset | ) | const |
Sets offset for family driver.
| offset | - IN: offset value |
| H5::PropListIException |
| void setFcloseDegree | ( | H5F_close_degree_t | degree | ) | const |
Sets the degree for the file close behavior.
| degree | - IN: |
| H5::PropListIException |
| void setFileAccDirect | ( | size_t | boundary, |
| size_t | block_size, | ||
| size_t | cbuf_size ) const |
| void setFileLocking | ( | bool | use_file_locking, |
| bool | ignore_when_disabled ) const |
Sets file locking flags.
| use_file_locking | - IN: Flag that determines if file locks should |
| ignore_when_disabled | - IN: Flag that determines if file locks |
| H5::PropListIException |
| void setGcReferences | ( | unsigned | gc_ref = 0 | ) | const |
Sets garbage collecting references flag.
| gc_ref | - IN: Flag setting reference garbage collection to on (1) or off (0). |
| H5::PropListIException |
| void setLibverBounds | ( | H5F_libver_t | libver_low, |
| H5F_libver_t | libver_high ) const |
Sets bounds on versions of library format to be used when creating or writing objects.
| libver_low | - IN: Earliest version of the library that will be used for creating or writing objects |
| libver_high | - IN: Latest version of the library that will be |
| H5::PropListIException |
H5F_LIBVER_EARLIEST (Default) H5F_LIBVER_18 H5F_LIBVER_110 H5F_LIBVER_112 H5F_LIBVER_114 H5F_LIBVER_200 H5F_LIBVER_LATEST H5F_LIBVER_18 H5F_LIBVER_110 H5F_LIBVER_112 H5F_LIBVER_114 H5F_LIBVER_200 H5F_LIBVER_LATEST (Default)| void setLog | ( | const char * | logfile, |
| unsigned | flags, | ||
| size_t | buf_size ) const |
Modifies this file access property list to use the logging driver.
| logfile | - IN: Name of the log file |
| flags | - IN: Flags specifying the types of logging activity |
| buf_size | - IN: Size of the logging buffer |
| H5::PropListIException |
| void setLog | ( | const std::string & | logfile, |
| unsigned | flags, | ||
| size_t | buf_size ) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts.
| logfile | - IN: Name of the log file - string |
| flags | - IN: Flags specifying the types of logging activity |
| buf_size | - IN: Size of the logging buffer |
| void setMetaBlockSize | ( | hsize_t & | block_size | ) | const |
Sets the minimum size of metadata block allocations.
| block_size | - IN: Minimum size, in bytes, of metadata block allocations |
| H5::PropListIException |
| void setMultiType | ( | H5FD_mem_t | dtype | ) | const |
Sets data type for MULTI driver.
| dtype | - IN: Type of data |
| H5::PropListIException |
| void setSec2 | ( | ) | const |
Modifies this file access property list to use the sec2 driver.
| H5::PropListIException |
| void setSieveBufSize | ( | size_t | bufsize | ) | const |
Sets the maximum size of the data sieve buffer.
| bufsize | - IN: Maximum size, in bytes, of data sieve buffer |
| H5::PropListIException |
| void setSplit | ( | const FileAccPropList & | meta_plist, |
| const FileAccPropList & | raw_plist, | ||
| const char * | meta_ext = ".meta", | ||
| const char * | raw_ext = ".raw" ) const |
Emulates the old split file driver, which stored meta data in one file and raw data in another file.
| meta_plist | - IN: File access plist for the metadata file |
| raw_plist | - IN: File access plist for the raw data file |
| meta_ext | - IN: Metadata filename extension as char* |
| raw_ext | - IN: Raw data filename extension as char* |
| H5::PropListIException |
| void setSplit | ( | const FileAccPropList & | meta_plist, |
| const FileAccPropList & | raw_plist, | ||
| const std::string & | meta_ext = ".meta", | ||
| const std::string & | raw_ext = ".raw" ) const |
This is an overloaded member function, provided for convenience. It takes character arguments as H5std_string.
| meta_plist | - IN: File access plist for the metadata file |
| raw_plist | - IN: File access plist for the raw data file |
| meta_ext | - IN: Metadata filename extension as H5std_string |
| raw_ext | - IN: Raw data filename extension as H5std_string |
| H5::PropListIException |
| void setStdio | ( | ) | const |
Modifies this property list to use the H5FD_STDIO driver.
| H5::PropListIException |
|
static |
Default file access property list.