28 H5File(
const char* name,
unsigned int flags,
31 H5File(
const H5std_string& name,
unsigned int flags,
36 void openFile(
const H5std_string& name,
unsigned int flags,
38 void openFile(
const char* name,
unsigned int flags,
51 void getFileInfo(H5F_info2_t& file_info)
const;
54 hssize_t getFreeSpace()
const;
58 ssize_t getObjCount(
unsigned types = H5F_OBJ_ALL)
const;
62 void getObjIDs(
unsigned types,
size_t max_objs, hid_t *oid_list)
const;
65 void getVFDHandle(
void **file_handle)
const;
66 void getVFDHandle(
const FileAccPropList& fapl,
void **file_handle)
const;
70 hsize_t getFileSize()
const;
73 unsigned long getFileNum()
const;
76 static bool isHdf5(
const char* name);
77 static bool isHdf5(
const H5std_string& name);
86 #ifndef DOXYGEN_SHOULD_SKIP_THIS
93 #endif // DOXYGEN_SHOULD_SKIP_THIS
96 virtual H5std_string
fromClass ()
const {
return(
"H5File"); }
99 virtual void throwException(
const H5std_string& func_name,
const H5std_string& msg)
const;
102 virtual hid_t getLocId()
const;
111 virtual hid_t getId()
const;
117 #ifndef DOXYGEN_SHOULD_SKIP_THIS
119 virtual void p_setId(
const hid_t new_id);
120 #endif // DOXYGEN_SHOULD_SKIP_THIS
Exception provides wrappers of HDF5 error handling functions.
Definition: H5Exception.h:32
void getFileInfo(H5F_info2_t &file_info) const
Retrieves the general information of this file.
Definition: H5File.cpp:401
virtual void close()
Closes this HDF5 file.
Definition: H5File.cpp:684
void getVFDHandle(void **file_handle) const
This is an overloaded member function, provided for convenience. It differs from the above function o...
Definition: H5File.cpp:552
FileAccPropList getAccessPlist() const
Returns a copy of the access property list of this file.
Definition: H5File.cpp:374
void incRefCount() const
Increment reference counter for the id of this object.
Definition: H5IdComponent.cpp:53
void reOpen()
Reopens this file.
Definition: H5File.cpp:327
void openFile(const H5std_string &name, unsigned int flags, const FileAccPropList &access_plist=FileAccPropList::DEFAULT)
This is an overloaded member function, provided for convenience. It takes an H5std_string for name.
Definition: H5File.cpp:306
static bool isHdf5(const char *name)
Determines whether a file in HDF5 format. (Static)
Definition: H5File.cpp:193
Definition: H5Exception.h:95
static const FileAccPropList & DEFAULT
Default file access property list.
Definition: H5FaccProp.h:28
static bool isAccessible(const char *name, const FileAccPropList &access_plist=FileAccPropList::DEFAULT)
Determines whether a file can be accessed as HDF5. (Static)
Definition: H5File.cpp:231
virtual hid_t getId() const
Get the id of this file.
Definition: H5File.cpp:615
Class Group represents an HDF5 group.
Definition: H5Group.h:24
hssize_t getFreeSpace() const
Returns the amount of free space in the file.
Definition: H5File.cpp:417
H5File()
Default constructor: creates a stub H5File object.
Definition: H5File.cpp:52
Class FileCreatPropList inherits from PropList and provides wrappers for the HDF5 file create propert...
Definition: H5FcreatProp.h:25
FileCreatPropList getCreatePlist() const
Returns a copy of the creation property list of this file.
Definition: H5File.cpp:350
hsize_t getFileSize() const
Returns the file size of the HDF5 file.
Definition: H5File.cpp:571
H5std_string getDetailMsg() const
Returns the detailed message set at the time the exception is thrown.
Definition: H5Exception.cpp:256
static const FileCreatPropList & DEFAULT
Default file creation property list.
Definition: H5FcreatProp.h:28
virtual void throwException(const H5std_string &func_name, const H5std_string &msg) const
Throws file exception - initially implemented for CommonFG.
Definition: H5File.cpp:711
Class H5File represents an HDF5 file and inherits from class Group as file is a root group.
Definition: H5File.h:25
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.
Definition: H5File.cpp:484
unsigned long getFileNum() const
Returns the file number of the HDF5 file.
Definition: H5File.cpp:592
virtual hid_t getId() const
Get the id of this property list.
Definition: H5PropList.cpp:292
virtual hid_t getLocId() const
virtual H5std_string fromClass() const
Returns this class name.
Definition: H5File.h:96
virtual ~H5File()
Properly terminates access to this file.
Definition: H5File.cpp:728
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.
Definition: H5File.cpp:449
Definition: H5AbstractDs.cpp:34
Class FileAccPropList inherits from PropList and provides wrappers for the HDF5 file access property ...
Definition: H5FaccProp.h:25
The HDF Group Help Desk:
| |
Copyright by
The HDF Group
and the Board of Trustees of the University of Illinois
|