hops
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Member Functions | Friends | List of all members
HighFive::DataType Class Reference

HDF5 Data Type. More...

#include <H5DataType.hpp>

Inheritance diagram for HighFive::DataType:
Inheritance graph
Collaboration diagram for HighFive::DataType:
Collaboration graph

Public Member Functions

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...
 

Protected Member Functions

 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)
 
Objectoperator= (const Object &other)
 

Friends

class Attribute
 
class File
 
class DataSet
 

Additional Inherited Members

- Protected Attributes inherited from HighFive::Object
hid_t _hid
 

Detailed Description

HDF5 Data Type.

Member Function Documentation

◆ empty()

bool HighFive::DataType::empty ( ) const
inlinenoexcept

Check the DataType was default constructed. Such value might represent auto-detection of the datatype from a buffer.

◆ getClass()

DataTypeClass HighFive::DataType::getClass ( ) const
inline

Return the fundamental type.

◆ 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
inlineprotected

◆ Object() [3/4]

HighFive::Object::Object
inlineexplicitprotected

◆ Object() [4/4]

HighFive::Object::Object
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 Function Documentation

◆ Attribute

friend class Attribute
friend

◆ DataSet

friend class DataSet
friend

◆ File

friend class File
friend

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