Interface class for io classes that support annotation channels organized in different groups. More...

#include <GroupedChannelIO.hpp>

Inheritance diagram for lvr2::GroupedChannelIO:

[legend]

Public Member Functions
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 More...

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 More...

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 More...

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 More...

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 More...

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 More...

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 More...

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 More...

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 More...

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 More...

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 More...

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 More...

Detailed Description

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

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

Definition at line 42 of file descriptions/GroupedChannelIO.hpp.

Member Function Documentation

◆ addChannel() [1/6]

virtual bool lvr2::GroupedChannelIO::addChannel	(	const std::string	group,
		const std::string	name,
		const FloatChannel &	channel
	)

pure virtual

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

Implemented in lvr2::HDF5IO, lvr2::HDF5IO, lvr2::HDF5IO, lvr2::hdf5features::MeshIO< Derived >, lvr2::hdf5features::MeshIO< Derived >, lvr2::hdf5features::MeshIO< Derived >, lvr2::hdf5features::ChannelIO< Derived >, lvr2::hdf5features::ChannelIO< Derived >, and lvr2::hdf5features::ChannelIO< Derived >.

◆ addChannel() [2/6]

virtual bool lvr2::GroupedChannelIO::addChannel	(	const std::string	group,
		const std::string	name,
		const FloatChannel &	channel
	)

pure virtual

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

Implemented in lvr2::HDF5IO, lvr2::HDF5IO, lvr2::HDF5IO, lvr2::hdf5features::MeshIO< Derived >, lvr2::hdf5features::MeshIO< Derived >, lvr2::hdf5features::MeshIO< Derived >, lvr2::hdf5features::ChannelIO< Derived >, lvr2::hdf5features::ChannelIO< Derived >, and lvr2::hdf5features::ChannelIO< Derived >.

◆ addChannel() [3/6]

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

pure virtual

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

Implemented in lvr2::HDF5IO, lvr2::HDF5IO, lvr2::HDF5IO, lvr2::hdf5features::MeshIO< Derived >, lvr2::hdf5features::MeshIO< Derived >, lvr2::hdf5features::MeshIO< Derived >, lvr2::hdf5features::ChannelIO< Derived >, lvr2::hdf5features::ChannelIO< Derived >, and lvr2::hdf5features::ChannelIO< Derived >.

◆ addChannel() [4/6]

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

pure virtual

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

Implemented in lvr2::HDF5IO, lvr2::HDF5IO, lvr2::HDF5IO, lvr2::hdf5features::MeshIO< Derived >, lvr2::hdf5features::MeshIO< Derived >, lvr2::hdf5features::MeshIO< Derived >, lvr2::hdf5features::ChannelIO< Derived >, lvr2::hdf5features::ChannelIO< Derived >, and lvr2::hdf5features::ChannelIO< Derived >.

◆ addChannel() [5/6]

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

pure virtual

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

Implemented in lvr2::HDF5IO, lvr2::HDF5IO, lvr2::HDF5IO, lvr2::hdf5features::MeshIO< Derived >, lvr2::hdf5features::MeshIO< Derived >, lvr2::hdf5features::MeshIO< Derived >, lvr2::hdf5features::ChannelIO< Derived >, lvr2::hdf5features::ChannelIO< Derived >, and lvr2::hdf5features::ChannelIO< Derived >.

◆ addChannel() [6/6]

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

pure virtual

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

Implemented in lvr2::HDF5IO, lvr2::HDF5IO, lvr2::HDF5IO, lvr2::hdf5features::MeshIO< Derived >, lvr2::hdf5features::MeshIO< Derived >, lvr2::hdf5features::MeshIO< Derived >, lvr2::hdf5features::ChannelIO< Derived >, lvr2::hdf5features::ChannelIO< Derived >, and lvr2::hdf5features::ChannelIO< Derived >.

◆ getChannel() [1/6]

virtual bool lvr2::GroupedChannelIO::getChannel	(	const std::string	group,
		const std::string	name,
		FloatChannelOptional &	channel
	)

pure virtual

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

Implemented in lvr2::hdf5features::MeshIO< Derived >, and lvr2::hdf5features::ChannelIO< Derived >.

◆ getChannel() [2/6]

virtual bool lvr2::GroupedChannelIO::getChannel	(	const std::string	group,
		const std::string	name,
		FloatChannelOptional &	channel
	)

pure virtual

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

Implemented in lvr2::hdf5features::MeshIO< Derived >, and lvr2::hdf5features::ChannelIO< Derived >.

◆ getChannel() [3/6]

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

pure virtual

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

Implemented in lvr2::HDF5IO, lvr2::HDF5IO, lvr2::hdf5features::MeshIO< Derived >, lvr2::hdf5features::MeshIO< Derived >, lvr2::hdf5features::ChannelIO< Derived >, and lvr2::hdf5features::ChannelIO< Derived >.

◆ getChannel() [4/6]

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

pure virtual

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

Implemented in lvr2::HDF5IO, lvr2::HDF5IO, lvr2::hdf5features::MeshIO< Derived >, lvr2::hdf5features::MeshIO< Derived >, lvr2::hdf5features::ChannelIO< Derived >, and lvr2::hdf5features::ChannelIO< Derived >.

◆ getChannel() [5/6]

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

pure virtual

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

Implemented in lvr2::HDF5IO, lvr2::HDF5IO, lvr2::hdf5features::MeshIO< Derived >, lvr2::hdf5features::MeshIO< Derived >, lvr2::hdf5features::ChannelIO< Derived >, and lvr2::hdf5features::ChannelIO< Derived >.

◆ getChannel() [6/6]

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

pure virtual

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

Implemented in lvr2::HDF5IO, lvr2::HDF5IO, lvr2::hdf5features::MeshIO< Derived >, lvr2::hdf5features::MeshIO< Derived >, lvr2::hdf5features::ChannelIO< Derived >, and lvr2::hdf5features::ChannelIO< Derived >.

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

descriptions/GroupedChannelIO.hpp

Public Member Functions

Detailed Description

Member Function Documentation

◆ addChannel() [1/6]

◆ addChannel() [2/6]

◆ addChannel() [3/6]

◆ addChannel() [4/6]

◆ addChannel() [5/6]

◆ addChannel() [6/6]

◆ getChannel() [1/6]

◆ getChannel() [2/6]

◆ getChannel() [3/6]

◆ getChannel() [4/6]

◆ getChannel() [5/6]

◆ getChannel() [6/6]