Template Class ChannelIO

Inheritance Relationships

Base Type

Class Documentation

template<typename Derived>
class ChannelIO : public lvr2::GroupedChannelIO

Public Functions

template<typename T>
ChannelOptional<T> load(std::string groupName, std::string datasetName)
template<typename T>
ChannelOptional<T> load(HighFive::Group &g, std::string datasetName)
template<typename T>
ChannelOptional<T> loadChannel(std::string groupName, std::string datasetName)
template<typename T>
void save(std::string groupName, std::string datasetName, const Channel<T> &channel)
template<typename T>
void save(HighFive::Group &g, std::string datasetName, const Channel<T> &channel)
template<typename T>
void save(HighFive::Group &g, std::string datasetName, const Channel<T> &channel, std::vector<hsize_t> &chunkSize)

Protected Functions

template<typename T>
bool getChannel(const std::string group, const std::string name, boost::optional<AttributeChannel<T>> &channel)
virtual bool getChannel(const std::string group, const std::string name, FloatChannelOptional &channel)

getChannel Reads a float attribute channel in the given group with the given name

Parameters:

  • group – The associated attribute group

  • name – The associated attribute name

  • channel – The pointer to the float channel

Returns:

true if the channel has been loaded successfully, false otherwise

virtual bool getChannel(const std::string group, const std::string name, IndexChannelOptional &channel)

getChannel Reads an index attribute channel in the given group with the given name

Parameters:

  • group – The associated attribute group

  • name – The associated attribute name

  • channel – The pointer to the index channel

Returns:

true if the channel has been loaded successfully, false otherwise

virtual bool getChannel(const std::string group, const std::string name, UCharChannelOptional &channel)

getChannel Reads an unsigned char attribute channel in the given group with the given name

Parameters:

  • group – The associated attribute group

  • name – The associated attribute name

  • channel – The pointer to the unsigned char channel

Returns:

true if the channel has been loaded successfully, false otherwise

template<typename T>
bool addChannel(const std::string group, const std::string name, const AttributeChannel<T> &channel)
virtual bool addChannel(const std::string group, const std::string name, const FloatChannel &channel)

addChannel Writes a float attribute channel from the given group with the given name

Parameters:

  • group – The associated attribute group

  • name – The associated attribute name

  • channel – The pointer to the float channel which should be written

Returns:

true if the channel has been written successfully, false otherwise

virtual bool addChannel(const std::string group, const std::string name, const IndexChannel &channel)

addChannel Writes an index attribute channel from the given group with the given name

Parameters:

  • group – The associated attribute group

  • name – The associated attribute name

  • channel – The pointer to the index channel which should be written

Returns:

true if the channel has been written successfully, false otherwise

virtual bool addChannel(const std::string group, const std::string name, const UCharChannel &channel)

addChannel Writes an unsigned char attribute channel from the given group with the given name

Parameters:

  • group – The associated attribute group

  • name – The associated attribute name

  • channel – The pointer to the unsigned char channel which should be written

Returns:

true if the channel has been written successfully, false otherwise

Protected Attributes

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