Utopia::DataIO::HDFObject< objectcategory > Class Template Reference

Common base class for all HDF5 classes in the DATAIO Module i.e., for all classes that wrap HDF5-C-Library functionality like HDFDataset, HDFGroup, HDFFile. This class is not intendet as something to be used independently, but only as a base class to be inherited from. More...

#include <hdfobject.hh>

Collaboration diagram for Utopia::DataIO::HDFObject< objectcategory >:

Public Member Functions
void	swap (HDFObject &other)
	swap the state of the caller with the state of the argument
std::string	get_path () const
	Get the name or path object.
auto	get_id_object () const
	Get the id object.
auto	get_logger () const
	Get the logger object.
hid_t	get_C_id () const
	Get the C id object.
auto	get_refcount ()
	Get the reference count of object.
virtual bool	is_valid () const
	Check if the object is still valid.
void	close ()
	Close function which takes care of correctly closing the object and managing the reference counter.
void	bind_to (hid_t id, std::function< herr_t(hid_t) > closing_func, std::string path={})
	Open the object and bind it to a HDF5 object identified by 'id' with name 'path'. Object should be created beforehand.
	HDFObject ()
	Construct HDFObject from the given arguments.
	HDFObject (HDFObject &&other)
	Construct HDFObject by moving.
	HDFObject (const HDFObject &other)=default
	Construct HDFObject by copying another object.
	HDFObject (hid_t id, std::function< herr_t(hid_t) > closing_func, std::string path={})
	Construct HDFObject from the given argument.
HDFObject &	operator= (const HDFObject &other)
	Copy assignment operator.
HDFObject &	operator= (HDFObject &&other)
	move assignment operator
virtual	~HDFObject ()
	Destroy the HDFObject object. Has to be implemented in subclass!

Static Public Attributes
static constexpr HDFCategory	category = objectcategory
	Named variable for template arg.

Protected Attributes
HDFIdentifier	_id
	Identifier object that binds an instance of this class to an HDF5 object.
std::string	_path
	Name of the object.
std::shared_ptr< spdlog::logger >	_log
	pointer to the logger for dataio

Detailed Description

template<HDFCategory objectcategory>
class Utopia::DataIO::HDFObject< objectcategory >

Common base class for all HDF5 classes in the DATAIO Module i.e., for all classes that wrap HDF5-C-Library functionality like HDFDataset, HDFGroup, HDFFile. This class is not intendet as something to be used independently, but only as a base class to be inherited from.

Template Parameters

HDFCategory

type of object an instance of this class refers to

Constructor & Destructor Documentation

HDFObject() [1/4]

template<HDFCategory objectcategory>

Utopia::DataIO::HDFObject< objectcategory >::HDFObject ( )

inline

Construct HDFObject from the given arguments.

                : _id(), _path(""), _log(spdlog::get("data_io"))
    {
    }

HDFObject() [2/4]

template<HDFCategory objectcategory>

Utopia::DataIO::HDFObject< objectcategory >::HDFObject ( HDFObject< objectcategory > &&  other )

inline

Construct HDFObject by moving.

                                 :
        _id(std::move(other._id)), _path(std::move(other._path)),
        _log(std::move(other._log))
    {
        other._id.set_id(-1);
    }

HDFObject() [3/4]

template<HDFCategory objectcategory>

Utopia::DataIO::HDFObject< objectcategory >::HDFObject ( const HDFObject< objectcategory > &  other )

default

Construct HDFObject by copying another object.

HDFObject() [4/4]

template<HDFCategory objectcategory>

Utopia::DataIO::HDFObject< objectcategory >::HDFObject ( hid_t  id, std::function< herr_t(hid_t) >  closing_func, std::string  path = {}  )

inline

Construct HDFObject from the given argument.

Parameters

id	C-Library identifier, by rvalue reference count. This is done such that the id is 'stolen' by this object and hence reference counts stay the same
path	Name of the object

                                                  {}) :
        _log(spdlog::get("data_io"))
    {
        bind_to(id, closing_func, path);
    }

~HDFObject()

template<HDFCategory objectcategory>

virtual Utopia::DataIO::HDFObject< objectcategory >::~HDFObject ( )

inlinevirtual

Destroy the HDFObject object. Has to be implemented in subclass!

    {
        close();
    }

Member Function Documentation

bind_to()

template<HDFCategory objectcategory>

void Utopia::DataIO::HDFObject< objectcategory >::bind_to ( hid_t  id, std::function< herr_t(hid_t) >  closing_func, std::string  path = {}  )

inline

Open the object and bind it to a HDF5 object identified by 'id' with name 'path'. Object should be created beforehand.

Parameters

id	id of the object to bind to, by rvalue reference. This is made such that the given id is 'stolen' by this object and reference count remains unchanged
path	Name or path of the object to bind to

                                                {})
    {
        if (is_valid())
        {
            throw std::runtime_error("Error: Cannot bind object to new "
                                     "identifier while the old is still valid");
        }
 
        if (not check_validity(H5Iis_valid(id), path))
        {
            throw std::invalid_argument(
                "Error: invalid argument! The id given "
                "for an object of " +
                generate_object_name(*this) +
                " cannot be managed by an HDFObject instance!");
        }
 
        _log->debug("Opening object of ", generate_object_name(*this));
 
        _id.open(id, closing_func);
 
        if (path.size() == 0)
        {
            // putting some stupid special treatments here because HDF5
            // cannot handle things generically
 
            // attribute has to be treated separately
            if constexpr (category == HDFCategory::attribute)
            {
                _path.resize(H5Aget_name(id, 0, NULL) + 1);
 
                H5Aget_name(id, _path.size(), _path.data());
            }
            else
            {
 
                // a preliminary call to H5Iget_name will give the needed size.
                // cumbersome, but works. The +1 is for the null terminator
                _path.resize(H5Iget_name(id, NULL, 0)+1);
 
                // then, a second call will give the full name
                H5Iget_name(id, _path.data(), _path.size());
 
            }
 
            // remove the final 0 character, as std::string does not require it
            _path.pop_back();
        }
        else
        {
            _path = path;
        }
    }

close()

template<HDFCategory objectcategory>

void Utopia::DataIO::HDFObject< objectcategory >::close ( )

inline

Close function which takes care of correctly closing the object and managing the reference counter.

    {
 
        if (is_valid())
        {
            _id.close();
 
            _path = "";
        }
    }

get_C_id()

template<HDFCategory objectcategory>

hid_t Utopia::DataIO::HDFObject< objectcategory >::get_C_id ( ) const

inline

Get the C id object.

Returns

hid_t

    {
        return _id.get_id();
    }

get_id_object()

template<HDFCategory objectcategory>

auto Utopia::DataIO::HDFObject< objectcategory >::get_id_object ( ) const

inline

Get the id object.

Returns

hid_t C-Library identifier held by this object

    {
        return _id;
    }

get_logger()

template<HDFCategory objectcategory>

auto Utopia::DataIO::HDFObject< objectcategory >::get_logger ( ) const

inline

Get the logger object.

Returns

auto

    {
        return _log;
    }

get_path()

template<HDFCategory objectcategory>

std::string Utopia::DataIO::HDFObject< objectcategory >::get_path ( ) const

inline

Get the name or path object.

Returns

std::string name of the object

    {
        return _path;
    }

get_refcount()

template<HDFCategory objectcategory>

auto Utopia::DataIO::HDFObject< objectcategory >::get_refcount ( )

inline

Get the reference count of object.

Returns

auto

    {
        return _id.get_refcount();
    }

is_valid()

template<HDFCategory objectcategory>

virtual bool Utopia::DataIO::HDFObject< objectcategory >::is_valid ( ) const

inlinevirtual

Check if the object is still valid.

Returns

true

false

Reimplemented in Utopia::DataIO::HDFType.

    {
        if (get_C_id() == -1)
        {
            return false;
        }
        else
        {
            // use check_validity to provide correct name
            return check_validity(H5Iis_valid(get_C_id()), _path);
        }
    }

operator=() [1/2]

template<HDFCategory objectcategory>

HDFObject & Utopia::DataIO::HDFObject< objectcategory >::operator= ( const HDFObject< objectcategory > &  other )

inline

Copy assignment operator.

Parameters

other

Returns

HDFObject&

    {
        _id   = other._id;
        _path = other._path;
        _log  = other._log;
 
        return *this;
    }

operator=() [2/2]

template<HDFCategory objectcategory>

HDFObject & Utopia::DataIO::HDFObject< objectcategory >::operator= ( HDFObject< objectcategory > &&  other )

inline

move assignment operator

Parameters

other

Returns

HDFObject&

    {
        _id   = std::move(other._id);
        _path = std::move(other._path);
        _log  = std::move(other._log);
 
        other._id.set_id(-1);
 
        return *this;
    }

swap()

template<HDFCategory objectcategory>

void Utopia::DataIO::HDFObject< objectcategory >::swap ( HDFObject< objectcategory > &  other )

inline

swap the state of the caller with the state of the argument

Parameters

other

    {
        using std::swap;
        swap(_id, other._id);
        swap(_path, other._path);
        swap(_log, other._log);
    }

Member Data Documentation

_id

template<HDFCategory objectcategory>

HDFIdentifier Utopia::DataIO::HDFObject< objectcategory >::_id

protected

Identifier object that binds an instance of this class to an HDF5 object.

_log

template<HDFCategory objectcategory>

std::shared_ptr< spdlog::logger > Utopia::DataIO::HDFObject< objectcategory >::_log

protected

pointer to the logger for dataio

_path

template<HDFCategory objectcategory>

std::string Utopia::DataIO::HDFObject< objectcategory >::_path

protected

Name of the object.

category

template<HDFCategory objectcategory>

constexpr HDFCategory Utopia::DataIO::HDFObject< objectcategory >::category = objectcategory

staticconstexpr

Named variable for template arg.

---

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

• include/utopia/data_io/hdfobject.hh