FiberVISH 0.2
Fish - The Fiber Bundle API for the Vish Visualization Shell
Public Types | Public Member Functions | Protected Member Functions | List of all members
H5LinkAccess Class Reference
Inheritance diagram for H5LinkAccess:
H5Property H5Property H5Identifier H5Object H5Identifier H5Object MemCore::ReferenceBase< H5Object > H5Identifier MemCore::ReferenceBase< H5Identifier > MemCore::ReferenceBase< H5Object > H5Identifier MemCore::ReferenceBase< H5Identifier > H5DatasetAccess H5DatasetAccess H5ExternalLinkAccess H5GroupAccess H5GroupAccess

Public Types

using elink_callback = std::function< herr_t(const char *parent_file_name, const char *parent_group_name, const char *child_file_name, const char *child_object_name, unsigned *acc_flags, hid_t fapl_id)>
 
typedef herr_t elink_callback_f(const char *parent_file_name, const char *parent_group_name, const char *child_file_name, const char *child_object_name, unsigned *acc_flags, hid_t fapl_id, void *op_data)
 
- Public Types inherited from H5Identifier
template<class T >
using refptr = MemCore::RefPtr< T >
 
- Public Types inherited from MemCore::ReferenceBase< H5Identifier >
typedef Object reference_domain_t
 
typedef WeakPtr< Object, Object > SelfPtr_t
 
- Public Types inherited from MemCore::ReferenceBase< H5Object >
typedef Object reference_domain_t
 
typedef WeakPtr< Object, Object > SelfPtr_t
 

Public Member Functions

herr_t set_elink_fapl (hid_t fapl_id)
 
herr_t set_elink_prefix (const char *prefix)
 
herr_t set_elink_cb (elink_callback_f f, void *op_data=nullptr)
 
herr_t set_elink_cb (elink_callback &F)
 
herr_t set_elink_acc_flags (unsigned flags)
 H5Pset_elink_acc_flags(); Possible values;.
 
herr_t open_external_links_readonly ()
 
herr_t open_external_links_writeable ()
 
herr_t open_external_links_like_container ()
 
herr_t set_elink_fapl (hid_t fapl_id)
 
- Public Member Functions inherited from H5Identifier
void inc_ref () const
 
void dec_ref () const
 
hid_t getHid () const
 Get the associated HDF5 ID.
 
hid_t getHidClone () const
 Get a copy of the associated HDF5 ID.
 
hid_t clone () const
 Get a copy of the associated HDF5 ID.
 
bool isValid () const
 Check whether this HDF5 object is valid, i.e., has a valid ID.
 
- Public Member Functions inherited from MemCore::ReferenceBase< H5Identifier >
auto getObjectCountID () const noexcept
 
bool isIdentical (const WeakPtr< Object, Object > &PossibleSelf) const noexcept
 
void mkAutoDestructive ()
 
refcount_t refcount () const noexcept
 
 ReferenceBase (Object *that) noexcept
 
const auto & self () const
 
refcount_t wrefcount () const noexcept
 
- Public Member Functions inherited from H5Object
 H5Object (hid_t parent_id, const char *name, hid_t link_access_properties=H5P_DEFAULT)
 H5Oopen()
 
 H5Object (const refptr< H5Object > &parent, const char *name, hid_t link_access_properties=H5P_DEFAULT)
 H5Oopen()
 
 H5Object (hid_t parent_id, const char *name, const H5LinkAccess &link_access_properties)
 H5Oopen()
 
 H5Object (const refptr< H5Object > &parent, const char *name, const H5LinkAccess &link_access_properties)
 H5Oopen()
 
bool Awrite (const char *AttributeName, hid_t file_type_id, hid_t mem_type_id, const void *data, size_t Elements) const
 
bool Awrite (const std::string &AttributeName, hid_t file_type_id, hid_t mem_type_id, const void *data, size_t Elements) const
 
template<class name_t >
bool Awrite (const name_t &AttributeName, hid_t type_id, const void *data, size_t Elements) const
 
template<class name_t >
bool Awrite (const name_t &AttributeName, const int16_t *data, size_t Elements) const
 
template<class name_t >
bool Awrite (const name_t &AttributeName, const int32_t *data, size_t Elements) const
 
template<class name_t >
bool Awrite (const name_t &AttributeName, const int64_t *data, size_t Elements) const
 
template<class name_t >
bool Awrite (const name_t &AttributeName, const uint16_t *data, size_t Elements) const
 
template<class name_t >
bool Awrite (const name_t &AttributeName, const uint32_t *data, size_t Elements) const
 
template<class name_t >
bool Awrite (const name_t &AttributeName, const uint64_t *data, size_t Elements) const
 
template<class name_t >
bool Awrite (const name_t &AttributeName, const double *data, size_t Elements=1) const
 
template<class name_t , class value_type >
bool Awrite (const name_t &AttributeName, const value_type &value) const
 
template<class T >
bool Awrite (const std::string &AttributeName, const std::vector< T > &data) const
 
bool Awrite (const char *AttributeName, const std::string &data) const
 
bool Awrite (const std::string &AttributeName, const std::string &data) const
 
std::string getFilename () const
 Get the filename associated with this HDF5 object.
 
std::string get_filename () const
 Get the filename associated with this HDF5 object.
 
std::filesystem::path getFilePath () const
 Get the filename associated with this HDF5 object.
 
std::string get_name () const
 
std::string get_object_path () const
 
std::string get_object_path_within_file () const
 
std::string get_path () const
 
herr_t get_info (H5O_info2_t &object_info, unsigned info_fields) const
 
time_t get_modification_time () const
 
hsize_t num_attribs () const
 
H5O_type_t get_type () const
 
refptr< H5Objectget_typed_object () const
 
time_t get_age () const
 
hid_t getHid () const
 
hid_t getHidClone () const
 
bool isValid () const
 
bool Awrite (const char *AttributeName, hid_t file_type_id, hid_t mem_type_id, const void *data, size_t Elements) const
 
bool Awrite (const std::string &AttributeName, hid_t file_type_id, hid_t mem_type_id, const void *data, size_t Elements) const
 
template<class name_t >
bool Awrite (const name_t &AttributeName, hid_t type_id, const void *data, size_t Elements) const
 
template<class name_t >
bool Awrite (const name_t &AttributeName, const int16_t *data, size_t Elements) const
 
template<class name_t >
bool Awrite (const name_t &AttributeName, const int32_t *data, size_t Elements) const
 
template<class name_t >
bool Awrite (const name_t &AttributeName, const int64_t *data, size_t Elements) const
 
template<class name_t >
bool Awrite (const name_t &AttributeName, const uint16_t *data, size_t Elements) const
 
template<class name_t >
bool Awrite (const name_t &AttributeName, const uint32_t *data, size_t Elements) const
 
template<class name_t >
bool Awrite (const name_t &AttributeName, const uint64_t *data, size_t Elements) const
 
template<class name_t >
bool Awrite (const name_t &AttributeName, const double *data, size_t Elements=1) const
 
template<class name_t , class value_type >
bool Awrite (const name_t &AttributeName, const value_type &value) const
 
template<class T >
bool Awrite (const std::string &AttributeName, const std::vector< T > &data) const
 
bool Awrite (const char *AttributeName, const std::string &data) const
 
bool Awrite (const std::string &AttributeName, const std::string &data) const
 
- Public Member Functions inherited from MemCore::ReferenceBase< H5Object >
auto getObjectCountID () const noexcept
 
bool isIdentical (const WeakPtr< Object, Object > &PossibleSelf) const noexcept
 
void mkAutoDestructive ()
 
refcount_t refcount () const noexcept
 
 ReferenceBase (Object *that) noexcept
 
const auto & self () const
 
refcount_t wrefcount () const noexcept
 

Protected Member Functions

 H5LinkAccess (hid_t)
 
 H5LinkAccess (hid_t)
 
- Protected Member Functions inherited from H5Property
 H5Property (hid_t)
 
 H5Property (hid_t)
 
- Protected Member Functions inherited from H5Identifier
 H5Identifier (hid_t id)
 
 H5Identifier (const H5Identifier &)=delete
 
H5Identifieroperator= (const H5Identifier &)=delete
 
- Protected Member Functions inherited from MemCore::ReferenceBase< H5Identifier >
virtual void extremeUnction ()
 
ReferenceBaseoperator= (const ReferenceBase &R)
 
void suicide ()
 
- Protected Member Functions inherited from H5Object
 H5Object (const H5Object &)=delete
 
H5Objectoperator= (const H5Object &)=delete
 
 H5Object (hid_t ID)
 
 H5Object (const H5Object &)=delete
 
H5Objectoperator= (const H5Object &)=delete
 
 H5Object (hid_t ID)
 
- Protected Member Functions inherited from MemCore::ReferenceBase< H5Object >
virtual void extremeUnction ()
 
ReferenceBaseoperator= (const ReferenceBase &R)
 
void suicide ()
 

Additional Inherited Members

- Static Public Member Functions inherited from H5Property
static hid_t getId (const refptr< H5Property > &P)
 Return the associated HDF5 ID if this is a valid pointer, otherwise return H5P_DEFAULT .
 
static hid_t getId (const MemCore::RefPtr< H5Property > &P)
 
- Static Public Member Functions inherited from H5Identifier
static consteval hid_t invalid_id ()
 
template<class Lambda >
static auto Silentio (const Lambda &L) -> decltype(L())
 
static bool isActive ()
 Check whether the HDF5 library is active, i.e., has been correctly initialized and not been closed already.
 
- Static Public Member Functions inherited from H5Object
static std::string getFilename (hid_t hid)
 Gets the filename associated with the given HDF5 ID, a wrapper to H5Fget_name() .
 
static std::filesystem::path getFilePath (hid_t hid)
 
static std::string get_name (hid_t hid)
 Gets the name associated with the given HDF5 ID, a wrapper to H5Iget_name() .
 
template<class Lambda >
static auto Silentio (const Lambda &L) -> decltype(L())
 
static bool isActive ()
 
static void CloseLibrary ()
 
- Protected Attributes inherited from H5Identifier
hid_t hid = 0
 
- Protected Attributes inherited from H5Object
hid_t hid
 

Member Function Documentation

◆ set_elink_acc_flags()

herr_t H5LinkAccess::set_elink_acc_flags ( unsigned  flags)
inline

H5Pset_elink_acc_flags(); Possible values;.

  1. H5F_ACC_RDWR - Causes files opened through external links to be opened with write access
  2. H5F_ACC_RDONLY - Causes files opened through external links to be opened with read-only access
  3. H5F_ACC_DEFAULT - Removes any external link file access flag setting from lapl_id, causing the file access flag setting to be taken from the parent file