HighFive 2.3.1
HighFive - Header-only C++ HDF5 interface
Loading...
Searching...
No Matches
HighFive::Object Class Reference

#include <H5Object.hpp>

Inheritance diagram for HighFive::Object:

Public Member Functions

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

Protected Attributes

hid_t _hid
 

Friends

template<typename Derivate >
class NodeTraits
 
template<typename Derivate >
class AnnotateTraits
 
class Reference
 

Constructor & Destructor Documentation

◆ ~Object()

HighFive::Object::~Object ( )
inline

◆ Object() [1/4]

HighFive::Object::Object ( )
inlineprotected

◆ Object() [2/4]

HighFive::Object::Object ( const Object other)
inlineprotected

◆ Object() [3/4]

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

◆ Object() [4/4]

HighFive::Object::Object ( hid_t  hid)
inlineexplicitprotected

Member Function Documentation

◆ 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
ObjectExceptionwhen 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=()

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

◆ operator==()

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

Friends And Related Symbol Documentation

◆ AnnotateTraits

template<typename Derivate >
friend class AnnotateTraits
friend

◆ NodeTraits

template<typename Derivate >
friend class NodeTraits
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: