robowflex::IO::HDF5File Class Reference

An HDF5 File loaded into memory. More...

#include <hdf5.h>

Public Types
typedef boost::make_recursive_variant< HDF5DataPtr, std::map< std::string, boost::recursive_variant_ > >::type	Node
	A recursive map that has a dictionary-like structure to store HDF5 datasets. More...
typedef std::map< std::string, Node >	NodeMap
	A specific map in the recursive set. More...

Public Member Functions
	HDF5File (const std::string &filename)
	Constructor. Opens filename. More...
const HDF5DataPtr	getData (const std::vector< std::string > &keys) const
	Get the dataset under the set of keys. Each key is applied successively. More...
const std::vector< std::vector< std::string > >	getKeys () const
	Gets all valid keys in the file. More...

Private Member Functions
template<typename T >
std::vector< std::string >	listObjects (const T &location) const
	List the objects at the HDF5 location. More...
template<typename T >
void	loadData (Node &node, const T &location, const std::string &name)
	Loads the data in the object name at the HDF5 location. Recursive. More...

Private Attributes
const H5::H5File	file_
	The loaded HDF5 file. More...
Node	data_
	A recursive map of loaded data. More...

Detailed Description

An HDF5 File loaded into memory.

Definition at line 89 of file hdf5.h.

Member Typedef Documentation

Node

typedef boost::make_recursive_variant< HDF5DataPtr, std::map<std::string, boost::recursive_variant_> >::type robowflex::IO::HDF5File::Node

A recursive map that has a dictionary-like structure to store HDF5 datasets.

Definition at line 95 of file hdf5.h.

NodeMap

typedef std::map<std::string, Node> robowflex::IO::HDF5File::NodeMap

A specific map in the recursive set.

Definition at line 98 of file hdf5.h.

Constructor & Destructor Documentation

HDF5File()

IO::HDF5File::HDF5File

(

const std::string &

filename

)

Constructor. Opens filename.

Parameters

[in]

filename

File to open.

IO::HDF5File

Definition at line 143 of file hdf5.cpp.

  : file_(IO::resolvePath(filename), H5F_ACC_RDONLY), data_(NodeMap())
{
    for (const auto &obj : listObjects(file_))
        loadData(data_, file_, obj);
}

Member Function Documentation

getData()

const IO::HDF5DataPtr IO::HDF5File::getData

(

const std::vector< std::string > &

keys

)

const

Get the dataset under the set of keys. Each key is applied successively.

Parameters

[in]

keys

The keys for the dataset to access.

Returns

The loaded HDF5 dataset.

Definition at line 220 of file hdf5.cpp.

{
    const NodeMap &node = boost::get<NodeMap>(data_);
    return getDataHelper(keys, node);
}

getKeys()

const std::vector< std::vector< std::string > > IO::HDF5File::getKeys

(

)

const

Gets all valid keys in the file.

Returns

All keys in the file. Keys are vectors of strings.

Definition at line 226 of file hdf5.cpp.

{
    const NodeMap &node = boost::get<NodeMap>(data_);
    std::vector<std::vector<std::string>> keys;
    std::vector<std::string> key;
 
    getKeysHelper(keys, key, node);
 
    return keys;
}

listObjects()

template<typename T >

template std::vector< std::string > IO::HDF5File::listObjects ( const T &  location ) const

private

List the objects at the HDF5 location.

Parameters

[in]

location

The location to search

Template Parameters

T	A HDF5 object.

Definition at line 238 of file hdf5.cpp.

{
    std::vector<std::string> names;
    for (hsize_t i = 0; i < location.getNumObjs(); ++i)
        names.emplace_back(location.getObjnameByIdx(i));
 
    return names;
}

loadData()

template<typename T >

template void IO::HDF5File::loadData ( Node &  node, const T &  location, const std::string &  name  )

private

Loads the data in the object name at the HDF5 location. Recursive.

Parameters

[in]	node	The node to add data to.
[in]	location	The location to search
[in]	name	The name to search for.

Template Parameters

T	A HDF5 object.

Definition at line 251 of file hdf5.cpp.

{
    auto &map = boost::get<NodeMap>(node);
 
#if ROBOWFLEX_AT_LEAST_KINETIC
    H5O_type_t type = location.childObjType(name);
#else
    H5O_type_t type = childObjType(location, name);
#endif
 
    switch (type)
    {
        case H5O_TYPE_GROUP:
        {
            map[name] = NodeMap();
 
            H5::Group group = location.openGroup(name);
            for (const auto &obj : listObjects(group))
                loadData(map[name], group, obj);
 
            break;
        }
        case H5O_TYPE_DATASET:
        {
            map[name] = std::make_shared<HDF5Data>(location, name);
            break;
        }
 
        // case H5O_TYPE_NAMED_DATATYPE:
        // case H5O_TYPE_NTYPES:
        default:
            break;
    };
}

Member Data Documentation

data_

Node robowflex::IO::HDF5File::data_

private

A recursive map of loaded data.

Definition at line 134 of file hdf5.h.

file_

const H5::H5File robowflex::IO::HDF5File::file_

private

The loaded HDF5 file.

Definition at line 133 of file hdf5.h.

---

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

• hdf5.h
• hdf5.cpp