Template Class VariantChannelIO

Defined in File VariantChannelIO.hpp

Class Documentation

template<typename Derived = ConstructType> class VariantChannelIO

Hdf5IO Feature for handling VariantChannel related IO.

This Feature of the Hdf5IO handles the IO of a VariantChannel object.

Example:

MyHdf5IO io;

// example data
using MultiChannel = VariantChannel<float, char, int>;
MultiChannel vchannel, vchannel_in;
Channel<float> samples(100,100);
vchannel = samples;

// writing
io.open("test.h5");
io.save("avariantchannel", vchannel);

// reading
vchannel_in = *io.loadVariantChannel<MultiChannel>("avariantchannel");

// if the type is known you can also load via ChannelIO
vchannel_in = *io.loadChannel<float>("avariantchannel");

Dependencies:

ChannelIO

Public Functions

template<typename ...Tp> void save(std::string groupName, std::string datasetName, const VariantChannel<Tp...> &vchannel)

template<typename ...Tp> void save(HighFive::Group &group, std::string datasetName, const VariantChannel<Tp...> &vchannel)

template<typename VariantChannelT> boost::optional<VariantChannelT> load(std::string groupName, std::string datasetName)

template<typename VariantChannelT> boost::optional<VariantChannelT> load(HighFive::Group &group, std::string datasetName)

template<typename VariantChannelT> boost::optional<VariantChannelT> loadVariantChannel(std::string groupName, std::string datasetName)

Protected Functions

template<typename VariantChannelT> boost::optional<VariantChannelT> loadDynamic(HighFive::DataType dtype, HighFive::Group &group, std::string name)

template<typename ...Tp> void saveDynamic(HighFive::Group &group, std::string datasetName, const VariantChannel<Tp...> &vchannel)

Protected Attributes

Derived *m_file_access = static_cast<Derived*>(this)

ChannelIO<Derived> *m_channel_io = static_cast<ChannelIO<Derived>*>(m_file_access)