15 #ifndef __H5Location_H
16 #define __H5Location_H
18 #include "H5Classes.h"
43 void flush(H5F_scope_t scope)
const;
46 H5std_string getFileName()
const;
48 #ifndef H5_NO_DEPRECATED_SYMBOLS
50 H5G_obj_t getObjType(
void *ref, H5R_type_t ref_type = H5R_OBJECT)
const;
54 H5O_type_t getRefObjType(
void *ref, H5R_type_t ref_type = H5R_OBJECT)
const;
59 void setComment(
const char* name,
const char* comment)
const;
60 void setComment(
const H5std_string& name,
const H5std_string& comment)
const;
61 void setComment(
const char* comment)
const;
62 void setComment(
const H5std_string& comment)
const;
65 ssize_t getComment(
const char* name,
size_t buf_size,
char* comment)
const;
66 H5std_string getComment(
const char* name,
size_t buf_size=0)
const;
67 H5std_string getComment(
const H5std_string& name,
size_t buf_size=0)
const;
70 void removeComment(
const char* name)
const;
71 void removeComment(
const H5std_string& name)
const;
75 void reference(
void* ref,
const char* name,
76 H5R_type_t ref_type = H5R_OBJECT)
const;
77 void reference(
void* ref,
const H5std_string& name,
78 H5R_type_t ref_type = H5R_OBJECT)
const;
79 void reference(
void* ref,
const char* name,
const DataSpace& dataspace,
80 H5R_type_t ref_type = H5R_DATASET_REGION)
const;
81 void reference(
void* ref,
const H5std_string& name,
const DataSpace& dataspace,
82 H5R_type_t ref_type = H5R_DATASET_REGION)
const;
125 H5std_string
getLinkval(
const char* link_name,
size_t size=0)
const;
126 H5std_string
getLinkval(
const H5std_string& link_name,
size_t size=0)
const;
142 H5O_type_t
childObjType(hsize_t index, H5_index_t index_type=H5_INDEX_NAME, H5_iter_order_t order=H5_ITER_INC,
const char* objname=
".")
const;
150 void getObjinfo(H5O_info_t& objinfo,
unsigned fields = H5O_INFO_BASIC)
const;
154 unsigned fields = H5O_INFO_BASIC,
156 void getObjinfo(
const H5std_string& name, H5O_info_t& objinfo,
157 unsigned fields = H5O_INFO_BASIC,
162 H5_iter_order_t order, hsize_t idx, H5O_info_t& objinfo,
163 unsigned fields = H5O_INFO_BASIC,
165 void getObjinfo(
const H5std_string& grp_name, H5_index_t idx_type,
166 H5_iter_order_t order, hsize_t idx, H5O_info_t& objinfo,
167 unsigned fields = H5O_INFO_BASIC,
170 #ifndef H5_NO_DEPRECATED_SYMBOLS
179 void getObjinfo(
const char* name, hbool_t follow_link, H5G_stat_t& statbuf)
const;
180 void getObjinfo(
const H5std_string& name, hbool_t follow_link, H5G_stat_t& statbuf)
const;
181 void getObjinfo(
const char* name, H5G_stat_t& statbuf)
const;
182 void getObjinfo(
const H5std_string& name, H5G_stat_t& statbuf)
const;
186 int iterateElems(
const char* name,
int *idx, H5G_iterate_t op,
void *op_data);
187 int iterateElems(
const H5std_string& name,
int *idx, H5G_iterate_t op,
void *op_data);
191 void link(
const char *target_name,
const char *link_name,
194 void link(
const H5std_string& target_name,
195 const H5std_string& link_name,
200 void link(
const char *curr_name,
201 const Group& new_loc,
const char *new_name,
204 void link(
const H5std_string& curr_name,
205 const Group& new_loc,
const H5std_string& new_name,
210 void link(
const char *curr_name,
211 const hid_t same_loc,
const char *new_name,
214 void link(
const H5std_string& curr_name,
215 const hid_t same_loc,
const H5std_string& new_name,
222 void link(H5L_type_t link_type,
const char* curr_name,
const char* new_name)
const;
223 void link(H5L_type_t link_type,
const H5std_string& curr_name,
const H5std_string& new_name)
const;
228 void unlink(
const H5std_string& link_name,
241 const Group& dst,
const char *dst_name,
245 const Group& dst,
const H5std_string& dst_name,
250 void copyLink(
const char *src_name,
const char *dst_name,
254 const H5std_string& dst_name,
260 const Group& dst,
const char* dst_name,
264 const Group& dst,
const H5std_string& dst_name,
269 void moveLink(
const char* src_name,
const char* dst_name,
273 const H5std_string& dst_name,
279 void move(
const char* src,
const char* dst)
const;
280 void move(
const H5std_string& src,
const H5std_string& dst)
const;
285 virtual void throwException(
const H5std_string& func_name,
const H5std_string& msg)
const;
291 #ifndef DOXYGEN_SHOULD_SKIP_THIS
303 void p_reference(
void* ref,
const char* name, hid_t space_id, H5R_type_t ref_type)
const;
306 hid_t p_dereference(hid_t loc_id,
const void* ref, H5R_type_t ref_type,
const PropList& plist,
const char* from_func);
308 #ifndef H5_NO_DEPRECATED_SYMBOLS
310 H5G_obj_t p_get_obj_type(
void *ref, H5R_type_t ref_type)
const;
314 H5O_type_t p_get_ref_obj_type(
void *ref, H5R_type_t ref_type)
const;
Class DSetAccPropList inherits from LinkAccPropList and provides wrappers for the HDF5 dataset access...
Definition: H5DaccProp.h:25
static const DSetAccPropList & DEFAULT
Default dataset creation property list.
Definition: H5DaccProp.h:28
Class DSetCreatPropList inherits from ObjCreatPropList and provides wrappers for the HDF5 dataset cre...
Definition: H5DcreatProp.h:29
static const DSetCreatPropList & DEFAULT
Default dataset creation property list.
Definition: H5DcreatProp.h:32
Class DataSet operates on HDF5 datasets.
Definition: H5DataSet.h:28
Class DataSpace inherits from IdComponent and provides wrappers for the HDF5's dataspaces.
Definition: H5DataSpace.h:25
Class DataType provides generic operations on HDF5 datatypes.
Definition: H5DataType.h:28
Class Group represents an HDF5 group.
Definition: H5Group.h:24
Class H5File represents an HDF5 file and inherits from class Group as file is a root group.
Definition: H5File.h:25
H5Location is an abstract base class, added in version 1.8.12.
Definition: H5Location.h:31
void getObjinfo(const H5std_string &name, hbool_t follow_link, H5G_stat_t &statbuf) const
H5G_obj_t getObjTypeByIdx(hsize_t idx, char *type_name) const
DataSet openDataSet(const H5std_string &name, const DSetAccPropList &dapl=DSetAccPropList::DEFAULT) const
void getObjinfo(const char *grp_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t idx, H5O_info_t &objinfo, unsigned fields=H5O_INFO_BASIC, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
Group createGroup(const char *name, size_t size_hint=0) const
Group openGroup(const H5std_string &name) const
H5L_info_t getLinkInfo(const H5std_string &link_name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
void move(const char *src, const char *dst) const
H5O_type_t childObjType(const char *objname) const
void link(const char *curr_name, const Group &new_loc, const char *new_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
H5std_string getLinkval(const char *link_name, size_t size=0) const
Group createGroup(const char *name, const LinkCreatPropList &lcpl) const
void getObjinfo(const H5std_string &grp_name, H5_index_t idx_type, H5_iter_order_t order, hsize_t idx, H5O_info_t &objinfo, unsigned fields=H5O_INFO_BASIC, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
void unmount(const H5std_string &name) const
void link(H5L_type_t link_type, const char *curr_name, const char *new_name) const
void moveLink(const char *src_name, const Group &dst, const char *dst_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
int iterateElems(const H5std_string &name, int *idx, H5G_iterate_t op, void *op_data)
H5O_type_t childObjType(const H5std_string &objname) const
unsigned childObjVersion(const char *objname) const
void link(const char *target_name, const char *link_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
void moveLink(const H5std_string &src_name, const H5std_string &dst_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
void unlink(const char *link_name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
ssize_t getObjnameByIdx(hsize_t idx, H5std_string &name, size_t size) const
ssize_t getObjnameByIdx(hsize_t idx, char *name, size_t size) const
void moveLink(const char *src_name, const char *dst_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
void copyLink(const char *src_name, const Group &dst, const char *dst_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
hsize_t getNumObjs() const
void move(const H5std_string &src, const H5std_string &dst) const
DataSet openDataSet(const char *name, const DSetAccPropList &dapl=DSetAccPropList::DEFAULT) const
H5L_info_t getLinkInfo(const char *link_name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
Group createGroup(const H5std_string &name, size_t size_hint=0) const
DataSet createDataSet(const H5std_string &name, const DataType &data_type, const DataSpace &data_space, const DSetCreatPropList &create_plist=DSetCreatPropList::DEFAULT, const DSetAccPropList &dapl=DSetAccPropList::DEFAULT, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT) const
H5O_type_t childObjType(hsize_t index, H5_index_t index_type=H5_INDEX_NAME, H5_iter_order_t order=H5_ITER_INC, const char *objname=".") const
H5G_obj_t getObjTypeByIdx(hsize_t idx, H5std_string &type_name) const
void link(const H5std_string &curr_name, const hid_t same_loc, const H5std_string &new_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
H5std_string getObjnameByIdx(hsize_t idx) const
Group openGroup(const char *name) const
void unlink(const H5std_string &link_name, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
void copyLink(const char *src_name, const char *dst_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
void link(H5L_type_t link_type, const H5std_string &curr_name, const H5std_string &new_name) const
void link(const H5std_string &target_name, const H5std_string &link_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
virtual void throwException(const H5std_string &func_name, const H5std_string &msg) const
For subclasses, H5File and Group, to throw appropriate exception.
void moveLink(const H5std_string &src_name, const Group &dst, const H5std_string &dst_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
void getObjinfo(const H5std_string &name, H5G_stat_t &statbuf) const
void mount(const H5std_string &name, const H5File &child, const PropList &plist) const
unsigned childObjVersion(const H5std_string &objname) const
void copyLink(const H5std_string &src_name, const Group &dst, const H5std_string &dst_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
void link(const H5std_string &curr_name, const Group &new_loc, const H5std_string &new_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
DataSet createDataSet(const char *name, const DataType &data_type, const DataSpace &data_space, const DSetCreatPropList &create_plist=DSetCreatPropList::DEFAULT, const DSetAccPropList &dapl=DSetAccPropList::DEFAULT, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT) const
Group createGroup(const H5std_string &name, const LinkCreatPropList &lcpl) const
void getObjinfo(H5O_info_t &objinfo, unsigned fields=H5O_INFO_BASIC) const
void getObjinfo(const H5std_string &name, H5O_info_t &objinfo, unsigned fields=H5O_INFO_BASIC, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
DataSpace getRegion(void *ref, H5R_type_t ref_type=H5R_DATASET_REGION) const
int iterateElems(const char *name, int *idx, H5G_iterate_t op, void *op_data)
void getObjinfo(const char *name, H5G_stat_t &statbuf) const
void mount(const char *name, const H5File &child, const PropList &plist) const
H5G_obj_t getObjTypeByIdx(hsize_t idx) const
void link(const char *curr_name, const hid_t same_loc, const char *new_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
void unmount(const char *name) const
void copyLink(const H5std_string &src_name, const H5std_string &dst_name, const LinkCreatPropList &lcpl=LinkCreatPropList::DEFAULT, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
void getObjinfo(const char *name, hbool_t follow_link, H5G_stat_t &statbuf) const
void getObjinfo(const char *name, H5O_info_t &objinfo, unsigned fields=H5O_INFO_BASIC, const LinkAccPropList &lapl=LinkAccPropList::DEFAULT) const
H5std_string getLinkval(const H5std_string &link_name, size_t size=0) const
Class IdComponent provides wrappers of the C functions that operate on an HDF5 identifier.
Definition: H5IdComponent.h:27
Class LinkAccPropList inherits from PropList and provides wrappers for the HDF5 link access property ...
Definition: H5LaccProp.h:25
static const LinkAccPropList & DEFAULT
Default link access property list.
Definition: H5LaccProp.h:28
Class LinkCreatPropList inherits from PropList and provides wrappers for the HDF5 link creation prope...
Definition: H5LcreatProp.h:25
static const LinkCreatPropList & DEFAULT
Default link creation property list.
Definition: H5LcreatProp.h:28
Class PropList inherits from IdComponent and provides wrappers for the HDF5 generic property list.
Definition: H5PropList.h:25
static const PropList & DEFAULT
Default property list.
Definition: H5PropList.h:28
Definition: H5AbstractDs.cpp:34