summaryrefslogtreecommitdiffstats
path: root/c++/src/H5File.h
diff options
context:
space:
mode:
Diffstat (limited to 'c++/src/H5File.h')
-rw-r--r--c++/src/H5File.h150
1 files changed, 78 insertions, 72 deletions
diff --git a/c++/src/H5File.h b/c++/src/H5File.h
index 1b1227f..9231d5f 100644
--- a/c++/src/H5File.h
+++ b/c++/src/H5File.h
@@ -23,111 +23,117 @@ namespace H5 {
*/
// Inheritance: Group -> CommonFG/H5Object -> H5Location -> IdComponent
class H5_DLLCPP H5File : public Group {
- public:
- // Creates or opens an HDF5 file.
- H5File(const char* name, unsigned int flags,
- const FileCreatPropList& create_plist = FileCreatPropList::DEFAULT,
- const FileAccPropList& access_plist = FileAccPropList::DEFAULT);
- H5File(const H5std_string& name, unsigned int flags,
- const FileCreatPropList& create_plist = FileCreatPropList::DEFAULT,
- const FileAccPropList& access_plist = FileAccPropList::DEFAULT);
+ public:
+ // Creates or opens an HDF5 file.
+ H5File(const char *name, unsigned int flags,
+ const FileCreatPropList &create_plist = FileCreatPropList::DEFAULT,
+ const FileAccPropList & access_plist = FileAccPropList::DEFAULT);
+ H5File(const H5std_string &name, unsigned int flags,
+ const FileCreatPropList &create_plist = FileCreatPropList::DEFAULT,
+ const FileAccPropList & access_plist = FileAccPropList::DEFAULT);
- // Open the file
- void openFile(const H5std_string& name, unsigned int flags,
- const FileAccPropList& access_plist = FileAccPropList::DEFAULT);
- void openFile(const char* name, unsigned int flags,
- const FileAccPropList& access_plist = FileAccPropList::DEFAULT);
+ // Open the file
+ void openFile(const H5std_string &name, unsigned int flags,
+ const FileAccPropList &access_plist = FileAccPropList::DEFAULT);
+ void openFile(const char *name, unsigned int flags,
+ const FileAccPropList &access_plist = FileAccPropList::DEFAULT);
- // Close this file.
- virtual void close();
+ // Close this file.
+ virtual void close();
- // Gets a copy of the access property list of this file.
- FileAccPropList getAccessPlist() const;
+ // Gets a copy of the access property list of this file.
+ FileAccPropList getAccessPlist() const;
- // Gets a copy of the creation property list of this file.
- FileCreatPropList getCreatePlist() const;
+ // Gets a copy of the creation property list of this file.
+ FileCreatPropList getCreatePlist() const;
- // Gets general information about this file.
- void getFileInfo(H5F_info2_t& file_info) const;
+ // Gets general information about this file.
+ void getFileInfo(H5F_info2_t &file_info) const;
- // Returns the amount of free space in the file.
- hssize_t getFreeSpace() const;
+ // Returns the amount of free space in the file.
+ hssize_t getFreeSpace() const;
- // Returns the number of opened object IDs (files, datasets, groups
- // and datatypes) in the same file.
- ssize_t getObjCount(unsigned types = H5F_OBJ_ALL) const;
+ // Returns the number of opened object IDs (files, datasets, groups
+ // and datatypes) in the same file.
+ ssize_t getObjCount(unsigned types = H5F_OBJ_ALL) const;
- // Retrieves a list of opened object IDs (files, datasets, groups
- // and datatypes) in the same file.
- void getObjIDs(unsigned types, size_t max_objs, hid_t *oid_list) const;
+ // Retrieves a list of opened object IDs (files, datasets, groups
+ // and datatypes) in the same file.
+ void getObjIDs(unsigned types, size_t max_objs, hid_t *oid_list) const;
- // Returns the pointer to the file handle of the low-level file driver.
- void getVFDHandle(void **file_handle) const;
- void getVFDHandle(const FileAccPropList& fapl, void **file_handle) const;
- //void getVFDHandle(FileAccPropList& fapl, void **file_handle) const; // removed from 1.8.18 and 1.10.1
+ // Returns the pointer to the file handle of the low-level file driver.
+ void getVFDHandle(void **file_handle) const;
+ void getVFDHandle(const FileAccPropList &fapl, void **file_handle) const;
+ // void getVFDHandle(FileAccPropList& fapl, void **file_handle) const; // removed from 1.8.18 and 1.10.1
- // Returns the file size of the HDF5 file.
- hsize_t getFileSize() const;
+ // Returns the file size of the HDF5 file.
+ hsize_t getFileSize() const;
- // Returns the 'file number' of the HDF5 file.
- unsigned long getFileNum() const;
+ // Returns the 'file number' of the HDF5 file.
+ unsigned long getFileNum() const;
- // Determines if a file, specified by its name, is in HDF5 format
- static bool isHdf5(const char* name);
- static bool isHdf5(const H5std_string& name);
+ // Determines if a file, specified by its name, is in HDF5 format
+ static bool isHdf5(const char *name);
+ static bool isHdf5(const H5std_string &name);
- // Determines if a file, specified by its name, can be accessed as HDF5
- static bool isAccessible(const char* name, const FileAccPropList& access_plist = FileAccPropList::DEFAULT);
- static bool isAccessible(const H5std_string& name, const FileAccPropList& access_plist = FileAccPropList::DEFAULT);
+ // Determines if a file, specified by its name, can be accessed as HDF5
+ static bool isAccessible(const char * name,
+ const FileAccPropList &access_plist = FileAccPropList::DEFAULT);
+ static bool isAccessible(const H5std_string & name,
+ const FileAccPropList &access_plist = FileAccPropList::DEFAULT);
- // Reopens this file.
- void reOpen(); // added for better name
+ // Reopens this file.
+ void reOpen(); // added for better name
#ifndef DOXYGEN_SHOULD_SKIP_THIS
- void reopen(); // obsolete in favor of reOpen()
+ void reopen(); // obsolete in favor of reOpen()
- // Creates an H5File using an existing file id. Not recommended
- // in applications.
- H5File(hid_t existing_id);
+ // Creates an H5File using an existing file id. Not recommended
+ // in applications.
+ H5File(hid_t existing_id);
#endif // DOXYGEN_SHOULD_SKIP_THIS
- ///\brief Returns this class name.
- virtual H5std_string fromClass () const { return("H5File"); }
+ ///\brief Returns this class name.
+ virtual H5std_string
+ fromClass() const
+ {
+ return ("H5File");
+ }
- // Throw file exception.
- virtual void throwException(const H5std_string& func_name, const H5std_string& msg) const;
+ // Throw file exception.
+ virtual void throwException(const H5std_string &func_name, const H5std_string &msg) const;
- // For CommonFG to get the file id.
- virtual hid_t getLocId() const;
+ // For CommonFG to get the file id.
+ virtual hid_t getLocId() const;
- // Default constructor
- H5File();
+ // Default constructor
+ H5File();
- // Copy constructor: same as the original H5File.
- H5File(const H5File& original);
+ // Copy constructor: same as the original H5File.
+ H5File(const H5File &original);
- // Gets the HDF5 file id.
- virtual hid_t getId() const;
+ // Gets the HDF5 file id.
+ virtual hid_t getId() const;
- // H5File destructor.
- virtual ~H5File();
+ // H5File destructor.
+ virtual ~H5File();
- protected:
+ protected:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
- // Sets the HDF5 file id.
- virtual void p_setId(const hid_t new_id);
+ // Sets the HDF5 file id.
+ virtual void p_setId(const hid_t new_id);
#endif // DOXYGEN_SHOULD_SKIP_THIS
- private:
- hid_t id; // HDF5 file id
+ private:
+ hid_t id; // HDF5 file id
- // This function is private and contains common code between the
- // constructors taking a string or a char*
- void p_get_file(const char* name, unsigned int flags, const FileCreatPropList& create_plist, const FileAccPropList& access_plist);
+ // This function is private and contains common code between the
+ // constructors taking a string or a char*
+ void p_get_file(const char *name, unsigned int flags, const FileCreatPropList &create_plist,
+ const FileAccPropList &access_plist);
}; // end of H5File
} // namespace H5
#endif // __H5File_H
-
generated by cgit v0.12 at 2024-11-16 10:20:31 (GMT)