HighFive::Object Class Reference

#include <H5Object.hpp>

Inheritance diagram for HighFive::Object:

Public Member Functions
	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

Protected Member Functions
	Object ()
	Object (const Object &other)
	Object (hid_t) noexcept
	~Object ()
Object &	operator= (const Object &other)
Object &	operator= (Object &&other)

Protected Attributes
hid_t	_hid

Friends
class	Reference
class	CompoundType

Constructor & Destructor Documentation

Object() [1/4]

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

inlinenoexcept

Object() [2/4]

HighFive::Object::Object ( )

inlineprotected

Object() [3/4]

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

inlineprotected

Object() [4/4]

HighFive::Object::Object ( hid_t  hid )

inlineexplicitprotectednoexcept

~Object()

HighFive::Object::~Object ( )

inlineprotected

Member Function Documentation

getAddress()

haddr_t HighFive::Object::getAddress ( ) const

inline

Address of an HDF5 object in the file.

Not all HDF5 files support addresses anymore. The more recent concept is a VOL token.

Since

3.0.0

getId()

hid_t HighFive::Object::getId ( ) const

inlinenoexcept

getId

Returns

internal HDF5 id to the object provided for C API compatibility

getInfo()

ObjectInfo HighFive::Object::getInfo ( ) const

inline

Retrieve several infos about the current object (address, dates, etc)

getType()

ObjectType HighFive::Object::getType ( ) const

inline

Gets the fundamental type of the object (dataset, group, etc)

Exceptions

ObjectException

when the _hid is negative or the type is custom and not registered yet

isValid()

bool HighFive::Object::isValid ( ) const

inlinenoexcept

isValid

Returns

true if current Object is a valid HDF5Object

operator=() [1/2]

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

inlineprotected

operator=() [2/2]

Object & HighFive::Object::operator= ( Object &&  other )

inlineprotected

operator==()

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

inlinenoexcept

Friends And Related Symbol Documentation

CompoundType

friend class CompoundType

friend

Reference

friend class Reference

friend

Member Data Documentation

_hid

hid_t HighFive::Object::_hid

protected

---

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

• highfive/H5Object.hpp
• highfive/bits/H5Object_misc.hpp