Utopia::DataIO::HDFGroup Class Reference

Class represting a HDFGroup, an object analogous to a folder for HDFFiles. More...

#include <hdfgroup.hh>

Inheritance diagram for Utopia::DataIO::HDFGroup:

Collaboration diagram for Utopia::DataIO::HDFGroup:

Public Types
using	Base = HDFObject< HDFCategory::group >

Public Member Functions
template<typename Attrdata >
void	add_attribute (std::string name, Attrdata attribute_data)
	write attribute
template<HDFCategory cat>
void	open (HDFObject< cat > &parent, std::string path)
	Bind the object to a new HDF5 Group, either opening existing or creating a new one at path 'path' in the HDF5 group 'parent'.
std::shared_ptr< HDFGroup >	open_group (std::string path)
	Opens a group.
std::shared_ptr< HDFDataset >	open_dataset (std::string path, std::vector< hsize_t > capacity={}, std::vector< hsize_t > chunksizes={}, std::size_t compresslevel=0)
	open a HDFDataset
void	delete_group (std::string path)
	Delete the group at the given relative path.
	HDFGroup ()=default
	Default constructor.
	HDFGroup (const HDFGroup &other)=default
	Construct a new HDFGroup object.
	HDFGroup (HDFGroup &&other)=default
	Construct a new HDFGroup object.
HDFGroup &	operator= (HDFGroup &&other)=default
	assignment operator
HDFGroup &	operator= (const HDFGroup &other)=default
	Copy assignment operator.
template<HDFCategory cat>
	HDFGroup (HDFObject< cat > &parent, std::string path)
	Construct a new HDFGroup object.
virtual	~HDFGroup ()=default
	Destroy the HDFGroup object.
Public Member Functions inherited from Utopia::DataIO::HDFObject< HDFCategory::group >
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!

Additional Inherited Members
Static Public Attributes inherited from Utopia::DataIO::HDFObject< HDFCategory::group >
static constexpr HDFCategory	category
	Named variable for template arg.
Protected Attributes inherited from Utopia::DataIO::HDFObject< HDFCategory::group >
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

Class represting a HDFGroup, an object analogous to a folder for HDFFiles.

Member Typedef Documentation

Base

using Utopia::DataIO::HDFGroup::Base = HDFObject< HDFCategory::group >

Constructor & Destructor Documentation

HDFGroup() [1/4]

Utopia::DataIO::HDFGroup::HDFGroup ( )

default

Default constructor.

HDFGroup() [2/4]

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

default

Construct a new HDFGroup object.

Parameters

other

The other

HDFGroup() [3/4]

Utopia::DataIO::HDFGroup::HDFGroup ( HDFGroup &&  other )

default

Construct a new HDFGroup object.

Parameters

other

The other

HDFGroup() [4/4]

template<HDFCategory cat>

Utopia::DataIO::HDFGroup::HDFGroup ( HDFObject< cat > &  parent, std::string  path  )

inline

Construct a new HDFGroup object.

Parameters

parent	The parent group to create or open the group in
name	The name of the group

Template Parameters

HDFObject

{ description }

    {
        open(parent, path);
    }

~HDFGroup()

virtual Utopia::DataIO::HDFGroup::~HDFGroup ( )

virtualdefault

Destroy the HDFGroup object.

Member Function Documentation

add_attribute()

template<typename Attrdata >

void Utopia::DataIO::HDFGroup::add_attribute ( std::string  name, Attrdata  attribute_data  )

inline

write attribute

Parameters

name	The name
attribute_data	The attribute data

Template Parameters

Attrdata

type of attribute data

    {
        HDFAttribute(*this, name).write(attribute_data);
    }

delete_group()

void Utopia::DataIO::HDFGroup::delete_group ( std::string  path )

inline

Delete the group at the given relative path.

Parameters

path	relative path to group to delete

    {
        this->_log->debug("Deleting group {} in {}", path, _path);
 
        // check if group exists in file. If it does, delete the link
        herr_t status = 1;
        if (is_valid())
        {
            // group exists, can be deleted
            status = H5Ldelete(get_C_id(), path.c_str(), H5P_DEFAULT);
            if (status < 0)
            {
                throw std::runtime_error("Deletion of group at path '" + path +
                                         "' failed! Wrong path?");
            }
        }
        // group does not exist, do nothing
    }

open()

template<HDFCategory cat>

void Utopia::DataIO::HDFGroup::open ( HDFObject< cat > &  parent, std::string  path  )

inline

Bind the object to a new HDF5 Group, either opening existing or creating a new one at path 'path' in the HDF5 group 'parent'.

Parameters

parent
path

    {
 
        this->_log->debug(
            "Opening group with path {} at parent {}", path, parent.get_path());
        // check if given path exists in parent
        if (path_is_valid(parent.get_C_id(), path))
        {
            // manage new group using his class
            bind_to(H5Gopen(parent.get_C_id(), path.c_str(), H5P_DEFAULT),
                    &H5Gclose,
                    path);
 
            if (get_C_id() < 0)
            {
                throw std::runtime_error("Group opening for path '" + path +
                                         "' failed!");
            }
        }
        else
        { // group does not exist yet
            // create the group and intermediates
            hid_t group_plist = H5Pcreate(H5P_LINK_CREATE);
            H5Pset_create_intermediate_group(group_plist, 1);
 
            // manage new group using his class
            bind_to(H5Gcreate(parent.get_C_id(),
                              path.c_str(),
                              group_plist,
                              H5P_DEFAULT,
                              H5P_DEFAULT),
                    &H5Gclose,
                    path);
 
            H5Pclose(group_plist);
 
            if (get_C_id() < 0)
            {
                throw std::runtime_error("Group creation for path '" + path +
                                         "' failed!");
            }
        }
    }

open_dataset()

std::shared_ptr< HDFDataset > Utopia::DataIO::HDFGroup::open_dataset ( std::string  path, std::vector< hsize_t >  capacity = {}, std::vector< hsize_t >  chunksizes = {}, std::size_t  compresslevel = 0  )

inline

open a HDFDataset

Template Parameters

HDFDataset

dataset type with parent type

Parameters

path	The path of the HDFDataset

Returns

A std::shared_ptr pointing at the newly created dataset

                                                      {},
                 std::vector< hsize_t > chunksizes    = {},
                 std::size_t            compresslevel = 0)
    {
        return std::make_shared< HDFDataset >(
            *this, path, capacity, chunksizes, compresslevel);
    }

open_group()

std::shared_ptr< HDFGroup > Utopia::DataIO::HDFGroup::open_group ( std::string  path )

inline

Opens a group.

Parameters

path	The path to open

Returns

std::shared_ptr<HDFGroup>

    {
        return std::make_shared< HDFGroup >(*this, path);
    }

operator=() [1/2]

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

default

Copy assignment operator.

Parameters

other

Returns

HDFGroup&

operator=() [2/2]

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

default

assignment operator

Parameters

other

The other

Returns

HDFGroup&

---

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

• include/utopia/data_io/hdfgroup.hh