HighFive::DataType Class Reference

HDF5 Data Type. More...

#include <H5DataType.hpp>

Inheritance diagram for HighFive::DataType:

Collaboration diagram for HighFive::DataType:

Public Member Functions
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
	~Object ()
bool	isValid () const noexcept
	isValid
hid_t	getId () const noexcept
	getId
ObjectInfo	getInfo () const
	Retrieve several infos about the current object (address, dates, etc)
ObjectType	getType () const
	Gets the fundamental type of the object (dataset, group, etc)
bool	operator== (const Object &other) const noexcept

Protected Member Functions
	Object (Object &&other) noexcept
	Object ()
	Object (const Object &other)
	Object (hid_t)
Protected Member Functions inherited from HighFive::Object
	Object ()
	Object (const Object &other)
	Object (hid_t)
Object &	operator= (const Object &other)

Friends
class	Attribute
class	File
class	DataSet
class	CompoundType
template<typename Derivate >
class	NodeTraits

Additional Inherited Members
Protected Attributes inherited from HighFive::Object
hid_t	_hid

Detailed Description

HDF5 Data Type.

Member Function Documentation

asStringType()

StringType HighFive::DataType::asStringType ( ) const

inline

Returns this datatype as a StringType.

empty()

bool HighFive::DataType::empty ( ) const

inlinenoexcept

Check the DataType was default constructed.

getClass()

DataTypeClass HighFive::DataType::getClass ( ) const

inline

Return the fundamental type.

getCreatePropertyList()

DataTypeCreateProps HighFive::DataType::getCreatePropertyList ( ) const

inline

Get the list of properties for creation of this DataType.

getSize()

size_t HighFive::DataType::getSize ( ) const

inline

Returns the length (in bytes) of this type elements.

Notice that the size of variable length sequences may have limited applicability given that it refers to the size of the control structure. For info see https://support.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetSize

isFixedLenStr()

bool HighFive::DataType::isFixedLenStr ( ) const

inline

Returns whether the type is a fixed-length string.

isReference()

bool HighFive::DataType::isReference ( ) const

inline

Returns whether the type is a Reference.

isVariableStr()

bool HighFive::DataType::isVariableStr ( ) const

inline

Returns whether the type is a variable-length string.

Object() [1/4]

HighFive::Object::Object ( )

inlineprotected

Object() [2/4]

HighFive::Object::Object ( const Object & other )

inlineprotected

Object() [3/4]

HighFive::Object::Object ( hid_t hid )

inlineexplicitprotected

Object() [4/4]

HighFive::Object::Object ( Object && other )

inlineprotectednoexcept

operator!=()

bool HighFive::DataType::operator!= ( const DataType & other ) const

inline

operator==()

bool HighFive::DataType::operator== ( const DataType & other ) const

inline

string()

std::string HighFive::DataType::string ( ) const

inline

Returns a friendly description of the type (e.g. Float32)

Friends And Related Symbol Documentation

Attribute

friend class Attribute

friend

CompoundType

friend class CompoundType

friend

DataSet

friend class DataSet

friend

File

friend class File

friend

NodeTraits

template<typename Derivate >

friend class NodeTraits

friend

---

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

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