Utopia::DataIO::HDFIdentifier Class Reference

Wrapper class around an hdf5 identifier, used to manage reference counts of the object this identifier refers to. More...

#include <hdfidentifier.hh>

Public Member Functions
void	swap (HDFIdentifier &other)
	Exchange states between caller and 'other'.
hid_t	get_id () const
	Get the HDF5 id held by this object.
void	set_id (hid_t id)
	Set id to the given argument. Only to be used to invalidate objects upon move or similar.
bool	is_valid () const
	Check if thi ID refers to a valid object.
auto	get_refcount () const
	Get the number of references currently referring to the object identified by this ID.
void	increment_refcount ()
	Increase the reference count of the object referred to by this ID by one.
void	decrement_refcount ()
	Decrease the reference count of the object referred to by this ID by one.
void	close ()
	Close the identifier and render the C-Level id held invalid.
void	open (hid_t id, std::function< herr_t(hid_t) > closing_func)
	Open the object and bind it to another C-Level id.
	HDFIdentifier (hid_t id, std::function< herr_t(hid_t) > closing_func)
	Construct HDFIdentifier from the given arguments.
	HDFIdentifier ()
	Construct HDFIdentifier from the given arguments.
	HDFIdentifier (const HDFIdentifier &other)
	Construct HDFIdentifier by copying another instance of HDFIdentifier, incrementing the refcount of the held id in the process.
	HDFIdentifier (HDFIdentifier &&other)
	Construct HDFIdentifier by moving from another instance of HDFIdentifier.
HDFIdentifier &	operator= (const HDFIdentifier &other)
	Assign HDFIdentifier by copying another instance of HDFIdentifier, incrementing the refcount of the held id in the process.
HDFIdentifier &	operator= (HDFIdentifier &&other)
	Assign HDFIdentifier by moving from another instance of HDFIdentifier.
	~HDFIdentifier ()
	Destroy the HDFIdentifier object, decrementing its refcount.

Private Attributes
hid_t	_id = -1
std::function< herr_t(hid_t) >	_closing_func

Detailed Description

Wrapper class around an hdf5 identifier, used to manage reference counts of the object this identifier refers to.

Constructor & Destructor Documentation

HDFIdentifier() [1/4]

Utopia::DataIO::HDFIdentifier::HDFIdentifier ( hid_t  id, std::function< herr_t(hid_t) >  closing_func  )

inline

Construct HDFIdentifier from the given arguments.

Parameters

id	C-Level id that is to be wrappend into an object of this class. Management of this id is then taken over by this class instance. Continuing to do so using the C-Interface outside of this class will result in errors.

    {
        open(id, closing_func);
    }

HDFIdentifier() [2/4]

Utopia::DataIO::HDFIdentifier::HDFIdentifier ( )

inline

Construct HDFIdentifier from the given arguments.

                    : _id(-1), _closing_func([](hid_t) -> herr_t { return 0; })
    {
    }

HDFIdentifier() [3/4]

Utopia::DataIO::HDFIdentifier::HDFIdentifier ( const HDFIdentifier &  other )

inline

Construct HDFIdentifier by copying another instance of HDFIdentifier, incrementing the refcount of the held id in the process.

Parameters

other

Object to copy from

                                              :
        _id(other._id), _closing_func(other._closing_func)
    {
        increment_refcount();
 
    }

HDFIdentifier() [4/4]

Utopia::DataIO::HDFIdentifier::HDFIdentifier ( HDFIdentifier &&  other )

inline

Construct HDFIdentifier by moving from another instance of HDFIdentifier.

                                         :
        _id(std::move(other._id)), _closing_func(std::move(other._closing_func))
    {
        other._id = -1;
    }

~HDFIdentifier()

Utopia::DataIO::HDFIdentifier::~HDFIdentifier ( )

inline

Destroy the HDFIdentifier object, decrementing its refcount.

    {
        close();
    }

Member Function Documentation

close()

void Utopia::DataIO::HDFIdentifier::close ( )

inline

Close the identifier and render the C-Level id held invalid.

    {
        if (is_valid())
        {
            if (H5Iget_ref(_id) > 1)
            {
                decrement_refcount();
            }
            else
            {
                _closing_func(_id);
            }
        }
        _id = -1;
    }

decrement_refcount()

void Utopia::DataIO::HDFIdentifier::decrement_refcount ( )

inline

Decrease the reference count of the object referred to by this ID by one.

    {
        if (is_valid())
        {
            H5Idec_ref(_id);
        }
    }

get_id()

hid_t Utopia::DataIO::HDFIdentifier::get_id ( ) const

inline

Get the HDF5 id held by this object.

Returns

hid_t

    {
        return _id;
    }

get_refcount()

auto Utopia::DataIO::HDFIdentifier::get_refcount ( ) const

inline

Get the number of references currently referring to the object identified by this ID.

Returns

auto

    {
        if (is_valid())
        {
            return H5Iget_ref(_id);
        }
        else
        {
            return -1;
        }
    }

increment_refcount()

void Utopia::DataIO::HDFIdentifier::increment_refcount ( )

inline

Increase the reference count of the object referred to by this ID by one.

    {
        if (is_valid())
        {
            H5Iinc_ref(_id);
        }
    }

is_valid()

bool Utopia::DataIO::HDFIdentifier::is_valid ( ) const

inline

Check if thi ID refers to a valid object.

Returns

true

false

    {
        return check_validity(H5Iis_valid(_id), "identifier");
    }

open()

void Utopia::DataIO::HDFIdentifier::open ( hid_t  id, std::function< herr_t(hid_t) >  closing_func  )

inline

Open the object and bind it to another C-Level id.

Parameters

id

    {
        if (is_valid())
        {
            throw std::runtime_error(
                "Error, HDFIdentifier cannot bind to new identifier while "
                "still being valid. Close first.");
        }
        _id           = id;
        _closing_func = closing_func;
    }

operator=() [1/2]

HDFIdentifier & Utopia::DataIO::HDFIdentifier::operator= ( const HDFIdentifier &  other )

inline

Assign HDFIdentifier by copying another instance of HDFIdentifier, incrementing the refcount of the held id in the process.

Parameters

other

Object to copy from

    {
        _id           = other._id;
        _closing_func = other._closing_func;
 
        increment_refcount();
        return *this;
    }

operator=() [2/2]

HDFIdentifier & Utopia::DataIO::HDFIdentifier::operator= ( HDFIdentifier &&  other )

inline

Assign HDFIdentifier by moving from another instance of HDFIdentifier.

Returns

HDFIdentifier&

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

set_id()

void Utopia::DataIO::HDFIdentifier::set_id ( hid_t  id )

inline

Set id to the given argument. Only to be used to invalidate objects upon move or similar.

Parameters

id

    {
        _id = id;
    }

swap()

void Utopia::DataIO::HDFIdentifier::swap ( HDFIdentifier &  other )

inline

Exchange states between caller and 'other'.

Parameters

other

Identifier to exchange states with

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

Member Data Documentation

_closing_func

std::function< herr_t(hid_t) > Utopia::DataIO::HDFIdentifier::_closing_func

private

_id

hid_t Utopia::DataIO::HDFIdentifier::_id = -1

private

---

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

• include/utopia/data_io/hdfidentifier.hh