HighFive::CompoundType Class Reference

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 std::vector< member_def > &t_members, size_t size=0)
	Initializes a compound type from a vector of member definitions.
	CompoundType (std::vector< member_def > &&t_members, size_t size=0)
	CompoundType (const std::initializer_list< member_def > &t_members, size_t size=0)
	CompoundType (DataType &&type)
	Initializes a compound type from a DataType.
void	commit (const Object &object, const std::string &name) const
	Commit datatype into the given Object.
const std::vector< member_def > &	getMembers () const noexcept
	Get read access to the CompoundType members.
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.
size_t	getSize () const
	Returns the length (in bytes) of this type elements.
std::string	string () const
	Returns a friendly description of the type (e.g. Float32)
bool	isVariableStr () const
	Returns whether the type is a variable-length string.
bool	isFixedLenStr () const
	Returns whether the type is a fixed-length string.
StringType	asStringType () const
	Returns this datatype as a StringType.
bool	empty () const noexcept
	Check the DataType was default constructed.
bool	isReference () const
	Returns whether the type is a Reference.
DataTypeCreateProps	getCreatePropertyList () const
	Get the list of properties for creation of this DataType.
Public Member Functions inherited from HighFive::Object
	Object (Object &&other) noexcept
bool	isValid () const noexcept
	isValid
hid_t	getId () const noexcept
	getId
ObjectInfo	getInfo () const
	Retrieve several infos about the current object (address, dates, etc)
haddr_t	getAddress () const
	Address of an HDF5 object in the file.
ObjectType	getType () const
	Gets the fundamental type of the object (dataset, group, etc)
bool	operator== (const Object &other) const noexcept

Additional Inherited Members
Protected Member Functions inherited from HighFive::DataType
	Object (Object &&other) noexcept
	Object ()
	Object (const Object &other)
	Object (hid_t) noexcept
Protected Member Functions inherited from HighFive::Object
	Object ()
	Object (const Object &other)
	Object (hid_t) noexcept
	~Object ()
Object &	operator= (const Object &other)
Object &	operator= (Object &&other)
Protected Attributes inherited from HighFive::Object
hid_t	_hid

Detailed Description

Create a compound HDF5 datatype.

Constructor & Destructor Documentation

CompoundType() [1/4]

HighFive::CompoundType::CompoundType ( const std::vector< member_def > &  t_members, size_t  size = 0  )

inline

Initializes a compound type from a vector of member definitions.

Parameters

t_members
size

CompoundType() [2/4]

HighFive::CompoundType::CompoundType ( std::vector< member_def > &&  t_members, size_t  size = 0  )

inline

CompoundType() [3/4]

HighFive::CompoundType::CompoundType ( const std::initializer_list< member_def > &  t_members, size_t  size = 0  )

inline

CompoundType() [4/4]

HighFive::CompoundType::CompoundType ( DataType &&  type )

inlineexplicit

Initializes a compound type from a DataType.

Parameters

type

Member Function Documentation

commit()

void HighFive::CompoundType::commit ( const Object &  object, const std::string &  name  ) const

inline

Commit datatype into the given Object.

Parameters

object	Location to commit object into
name	Name to give the datatype

getMembers()

const std::vector< member_def > & HighFive::CompoundType::getMembers ( ) const

inlinenoexcept

Get read access to the CompoundType members.

---

The documentation for this class was generated from the following files:

• highfive/H5DataType.hpp
• highfive/bits/H5DataType_misc.hpp