FiberVISH 0.2
Fish - The Fiber Bundle API for the Vish Visualization Shell
Public Member Functions | Static Public Member Functions | List of all members
H5DataType Class Reference
Inheritance diagram for H5DataType:
H5Object H5Object H5Identifier MemCore::ReferenceBase< H5Object > H5Identifier MemCore::ReferenceBase< H5Object > MemCore::ReferenceBase< H5Identifier > MemCore::ReferenceBase< H5Identifier > Fiber::H5ID Fiber::H5NativeTypeID

Public Member Functions

 H5DataType (hid_t)
 
 H5DataType (hsize_t str_len, char padding)
 Create string type.
 
 H5DataType (hid_t FileLocation_id, const char *name)
 Open named datatype.
 
 H5DataType (const H5Group &, const char *name)
 
 H5DataType (const H5Dataset &, const char *name)
 
 H5DataType (hid_t CompoundType, int member_index)
 Open a member of a compound data type.
 
 H5DataType (const H5DataType &CompoundType, int member_index)
 
 H5DataType (hid_t base_type_id, unsigned rank, const hsize_t dims[])
 Create array datatype.
 
bool equal (hid_t) const
 
bool operator== (hid_t id) const
 
bool operator!= (hid_t id) const
 
bool commit (hid_t Location, const char *name) const
 
bool commit (hid_t Location, const std::string &name) const
 
int NumberOfMembers () const
 Retrieves the number of elements in a compound or enumeration datatype.
 
std::string getMemberName (unsigned field_idx) const
 
int get_member_index (const char *name) const
 
size_t get_size () const
 
hid_t get_class () const
 
htri_t detect_class (H5T_class_t dtype_class) const
 
bool detectClass (H5T_class_t dtype_class) const
 
bool is_array () const
 
int get_array_ndims () const
 
int get_array_dims (hsize_t dims[]) const
 
hid_t get_native_type (H5T_direction_t direction=H5T_DIR_ASCEND) const
 https://support.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetNativeType
 
MemCore::RefPtr< H5DataTypegetNativeType (H5T_direction_t direction=H5T_DIR_ASCEND) const
 
std::string get_description () const
 
 H5DataType (hid_t)
 
 H5DataType (hsize_t str_len, char padding)
 Create string type.
 
 H5DataType (hid_t Location, const char *name)
 Open named datatype.
 
 H5DataType (hid_t base_type_id, unsigned rank, const hsize_t dims[])
 Create array datatype.
 
bool equal (hid_t) const
 
bool operator== (hid_t id) const
 
bool operator!= (hid_t id) const
 
bool commit (hid_t Location, const char *name) const
 
bool commit (hid_t Location, const std::string &name) const
 
int NumberOfMembers () const
 Retrieves the number of elements in a compound or enumeration datatype.
 
std::string getMemberName (unsigned field_idx) const
 
size_t get_size () const
 
hid_t get_class () const
 
htri_t detect_class (H5T_class_t dtype_class) const
 
bool detectClass (H5T_class_t dtype_class) const
 
bool is_array () const
 
int get_array_ndims () const
 
int get_array_dims (hsize_t dims[]) const
 
hid_t get_native_type (H5T_direction_t direction=H5T_DIR_ASCEND) const
 https://support.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetNativeType
 
MemCore::RefPtr< H5DataTypegetNativeType (H5T_direction_t direction=H5T_DIR_ASCEND) const
 
- 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 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 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
 

Static Public Member Functions

static std::string getMemberName (hid_t id, unsigned field_idx)
 
static std::string get_description (hid_t type_id)
 
static bool is_committed (hid_t LocationID, const char *name)
 Check whether the given name in the given LocationID is a named datatype.
 
static bool is_committed (hid_t LocationID, const std::string &s)
 
static std::string getMemberName (hid_t id, unsigned field_idx)
 
static bool is (hid_t LocationID, const char *name)
 Check whether the given name in the given LocationID is a named datatype.
 
static bool is (hid_t LocationID, const std::string &s)
 
- 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 ()
 
- 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.
 

Additional Inherited Members

- 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
 
- 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 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 MemCore::ReferenceBase< H5Object >
virtual void extremeUnction ()
 
ReferenceBaseoperator= (const ReferenceBase &R)
 
void suicide ()
 
- Protected Attributes inherited from H5Object
hid_t hid
 
- Protected Attributes inherited from H5Identifier
hid_t hid = 0
 

Constructor & Destructor Documentation

◆ H5DataType() [1/4]

H5DataType::H5DataType ( hsize_t  str_len,
char  padding 
)

Create string type.

Parameters
padding' ' for space padding, '0' for null padding, anything else for null termination, including the number 0 itself

◆ H5DataType() [2/4]

H5DataType::H5DataType ( hid_t  FileLocation_id,
const char *  name 
)

Open named datatype.

Parameters
FileLocation_idA HDF5 identifier within a file, such as a group or dataset

◆ H5DataType() [3/4]

H5DataType::H5DataType ( hid_t  CompoundType,
int  member_index 
)

Open a member of a compound data type.

Don't call this function if the hid_t is not a compound data type.

◆ H5DataType() [4/4]

H5DataType::H5DataType ( hsize_t  str_len,
char  padding 
)

Create string type.

Parameters
padding' ' for space padding, '0' for null padding, anything else for null termination.

Member Function Documentation

◆ NumberOfMembers() [1/2]

int H5DataType::NumberOfMembers ( ) const

Retrieves the number of elements in a compound or enumeration datatype.

https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetNmembers

◆ NumberOfMembers() [2/2]

int H5DataType::NumberOfMembers ( ) const

Retrieves the number of elements in a compound or enumeration datatype.

https://www.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetNmembers