h5gt 0.2.0
C++ wrapper for HDF5 library (based on HighFive project)
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
h5gt::Object Class Reference
Inheritance diagram for h5gt::Object:
h5gt::Attribute h5gt::DataSet h5gt::DataSpace h5gt::DataType h5gt::File h5gt::Group h5gt::AtomicType< T > h5gt::AtomicType< FixedLenStringArray< StrLen > > h5gt::AtomicType< char[StrLen]> h5gt::CompoundType h5gt::EnumType< T >

Public Member Functions

void flush (bool globalScope=true)
 flush
 
bool isValid () const noexcept
 isValid
 
hid_t getId (const bool &increaseRefCount=false) const noexcept
 getId
 
std::string getFileName () const
 
std::string getPath () const
 return the path to the current group, dataset, datatype or attribute's holder
 
int getIdRefCount () const noexcept
 
ObjectInfo getObjectInfo () const
 Retrieve several infos about the current object (address, dates, etc)
 
ObjectType getObjectType () const
 Gets the fundamental type of the object (dataset, group, etc)
 

Protected Member Functions

 Object (const Object &other)
 
 Object (Object &&other) noexcept
 
 Object (const hid_t &)
 
 Object (const hid_t &, const ObjectType &, const bool &)
 
LinkInfo _getLinkInfo (const std::string &objPath) const
 getLinkInfo retrieve link info from an object with 'objPath'. This object must reside in the same container as current one.
 
std::string _unpackSoftLink (const std::string &objName) const
 
std::string _unpackExternalLink (const std::string &objName, std::string &fileName_out) const
 
void _unlink (const std::string &obj_name) const
 
Objectoperator= (const Object &other)
 
bool operator== (const Object &other) const
 When coparing objects h5gt::File must be open.
 

Protected Attributes

hid_t _hid
 

Friends

template<typename Derivate >
class NodeTraits
 
template<typename Derivate >
class AnnotateTraits
 
class Reference
 
class DataSpace
 
class File
 
class Group
 
class DataSet
 
class Attribute
 
class DataType
 
class Selection
 

Member Function Documentation

◆ _getLinkInfo()

LinkInfo h5gt::Object::_getLinkInfo ( const std::string & objPath) const
inlineprotected

getLinkInfo retrieve link info from an object with 'objPath'. This object must reside in the same container as current one.

Parameters
objPathrelative path to the object
Returns

◆ flush()

void h5gt::Object::flush ( bool globalScope = true)
inline

flush

Flushes all buffers associated with an object to disk. Object is used only to identify the file i.e. there is no difference whether to flush the dataset or group if they both belong to the same file. Scope may be global (flushes the entire virtual file) and local (flushes only the specified file)

◆ getId()

hid_t h5gt::Object::getId ( const bool & increaseRefCount = false) const
inlinenoexcept

getId

Returns
internal HDF5 id to the object provided for C API compatibility

◆ getObjectType()

ObjectType h5gt::Object::getObjectType ( ) 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

◆ getPath()

std::string h5gt::Object::getPath ( ) const
inline

return the path to the current group, dataset, datatype or attribute's holder

Returns
the path to the dataset

◆ isValid()

bool h5gt::Object::isValid ( ) const
inlinenoexcept

isValid

Returns
true if current Object is a valid HDF5Object

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