Class GroupedChannelIO

• Defined in File GroupedChannelIO.hpp

Inheritance Relationships

Derived Types

• public lvr2::hdf5features::ChannelIO< ConstructType > (Template Class ChannelIO)

• public lvr2::AttributeMeshIOBase (Class AttributeMeshIOBase)

• public lvr2::hdf5features::ChannelIO< Derived > (Template Class ChannelIO)

Class Documentation

class GroupedChannelIO

Interface class for io classes that support annotation channels organized in different groups like HDF5

Subclassed by lvr2::hdf5features::ChannelIO< ConstructType >, lvr2::AttributeMeshIOBase, lvr2::hdf5features::ChannelIO< Derived >

Public Functions

virtual bool getChannel(const std::string group, const std::string name, FloatChannelOptional &channel) = 0

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) = 0

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) = 0

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

virtual bool addChannel(const std::string group, const std::string name, const FloatChannel &channel) = 0

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) = 0

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) = 0

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