Create a compound HDF5 datatype. More...
#include <H5DataType.hpp>
Inheritance diagram for HighFive::CompoundType:
Collaboration diagram for HighFive::CompoundType:
Classes | |
| struct | member_def |
| Use for defining a sub-type of compound type. More... | |
Public Member Functions | |
| CompoundType (const CompoundType &other)=default | |
| CompoundType (const std::vector< member_def > &t_members, size_t size=0) | |
| Initializes a compound type from a vector of member definitions. More... | |
| CompoundType (std::vector< member_def > &&t_members, size_t size=0) | |
| CompoundType (const std::initializer_list< member_def > &t_members, size_t size=0) | |
| void | commit (const Object &object, const std::string &name) const |
| Commit datatype into the given Object. More... | |
| const std::vector< member_def > & | getMembers () const noexcept |
| Get read access to the CompoundType members. More... | |
 Public Member Functions inherited from HighFive::DataType | |
| bool | operator== (const DataType &other) const |
| bool | operator!= (const DataType &other) const |
| DataTypeClass | getClass () const |
| Return the fundamental type. More... | |
| size_t | getSize () const |
| Returns the length (in bytes) of this type elements. More... | |
| std::string | string () const |
| Returns a friendly description of the type (e.g. Float32) More... | |
| bool | isVariableStr () const |
| Returns whether the type is a variable-length string. More... | |
| bool | isFixedLenStr () const |
| Returns whether the type is a fixed-length string. More... | |
| bool | empty () const noexcept |
| Check the DataType was default constructed. Such value might represent auto-detection of the datatype from a buffer. More... | |
| bool | isReference () const |
| Returns whether the type is a Reference. More... | |
| Public Member Functions inherited from HighFive::Object | |
| ~Object () | |
| bool | isValid () const noexcept |
| isValid More... | |
| hid_t | getId () const noexcept |
| getId More... | |
| ObjectInfo | getInfo () const |
| Retrieve several infos about the current object (address, dates, etc) More... | |
| ObjectType | getType () const |
| Gets the fundamental type of the object (dataset, group, etc) More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from HighFive::DataType | |
| Object () | |
| Object (const Object &other) | |
| Object (Object &&other) noexcept | |
| Object (hid_t) | |
| Protected Member Functions inherited from HighFive::Object | |
| Object () | |
| Object (const Object &other) | |
| Object (Object &&other) noexcept | |
| Object (hid_t) | |
| Object & | operator= (const Object &other) |
| Protected Attributes inherited from HighFive::Object | |
| hid_t | _hid |
Detailed Description
Create a compound HDF5 datatype.
Constructor & Destructor Documentation
◆ CompoundType() [1/4]
|
default |
◆ CompoundType() [2/4]
|
inline |
Initializes a compound type from a vector of member definitions.
- Parameters
-
t_members size
◆ CompoundType() [3/4]
|
inline |
◆ CompoundType() [4/4]
|
inline |
Member Function Documentation
◆ commit()
|
inline |
Commit datatype into the given Object.
- Parameters
-
object Location to commit object into name Name to give the datatype
◆ getMembers()
|
inlinenoexcept |
Get read access to the CompoundType members.
The documentation for this class was generated from the following files:
