lvr2::hdf5features::ChannelIO< Derived > Class Template Reference

#include <ChannelIO.hpp>

Inheritance diagram for lvr2::hdf5features::ChannelIO< Derived >:

Public Member Functions
template<typename T >
ChannelOptional< T >	load (HighFive::Group &g, std::string datasetName)
template<typename T >
ChannelOptional< T >	load (std::string groupName, std::string datasetName)
template<typename T >
ChannelOptional< T >	loadChannel (std::string groupName, std::string datasetName)
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)
template<typename T >
void	save (std::string groupName, std::string datasetName, const Channel< T > &channel)

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

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

Detailed Description

template<typename Derived>
class lvr2::hdf5features::ChannelIO< Derived >

Definition at line 20 of file hdf5/ChannelIO.hpp.

Member Function Documentation

addChannel() [1/4]

template<typename Derived >

template<typename T >

bool lvr2::hdf5features::ChannelIO< Derived >::addChannel ( const std::string  group, const std::string  name, const AttributeChannel< T > &  channel  )

protected

addChannel() [2/4]

template<typename Derived >

virtual bool lvr2::hdf5features::ChannelIO< Derived >::addChannel ( const std::string  group, const std::string  name, const FloatChannel &  channel  )

protectedvirtual

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

Implements lvr2::GroupedChannelIO.

addChannel() [3/4]

template<typename Derived >

virtual bool lvr2::hdf5features::ChannelIO< Derived >::addChannel ( const std::string  group, const std::string  name, const IndexChannel &  channel  )

protectedvirtual

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

Implements lvr2::GroupedChannelIO.

addChannel() [4/4]

template<typename Derived >

virtual bool lvr2::hdf5features::ChannelIO< Derived >::addChannel ( const std::string  group, const std::string  name, const UCharChannel &  channel  )

protectedvirtual

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

Implements lvr2::GroupedChannelIO.

getChannel() [1/4]

template<typename Derived >

template<typename T >

bool lvr2::hdf5features::ChannelIO< Derived >::getChannel ( const std::string  group, const std::string  name, boost::optional< AttributeChannel< T >> &  channel  )

protected

getChannel() [2/4]

template<typename Derived >

virtual bool lvr2::hdf5features::ChannelIO< Derived >::getChannel ( const std::string  group, const std::string  name, FloatChannelOptional &  channel  )

protectedvirtual

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

Implements lvr2::GroupedChannelIO.

getChannel() [3/4]

template<typename Derived >

virtual bool lvr2::hdf5features::ChannelIO< Derived >::getChannel ( const std::string  group, const std::string  name, IndexChannelOptional &  channel  )

protectedvirtual

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

Implements lvr2::GroupedChannelIO.

getChannel() [4/4]

template<typename Derived >

virtual bool lvr2::hdf5features::ChannelIO< Derived >::getChannel ( const std::string  group, const std::string  name, UCharChannelOptional &  channel  )

protectedvirtual

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

Implements lvr2::GroupedChannelIO.

load() [1/2]

template<typename Derived >

template<typename T >

ChannelOptional<T> lvr2::hdf5features::ChannelIO< Derived >::load	(	HighFive::Group &	g,
		std::string	datasetName
	)

load() [2/2]

template<typename Derived >

template<typename T >

ChannelOptional<T> lvr2::hdf5features::ChannelIO< Derived >::load	(	std::string	groupName,
		std::string	datasetName
	)

loadChannel()

template<typename Derived >

template<typename T >

ChannelOptional<T> lvr2::hdf5features::ChannelIO< Derived >::loadChannel	(	std::string	groupName,
		std::string	datasetName
	)

save() [1/3]

template<typename Derived >

template<typename T >

void lvr2::hdf5features::ChannelIO< Derived >::save	(	HighFive::Group &	g,
		std::string	datasetName,
		const Channel< T > &	channel
	)

save() [2/3]

template<typename Derived >

template<typename T >

void lvr2::hdf5features::ChannelIO< Derived >::save	(	HighFive::Group &	g,
		std::string	datasetName,
		const Channel< T > &	channel,
		std::vector< hsize_t > &	chunkSize
	)

save() [3/3]

template<typename Derived >

template<typename T >

void lvr2::hdf5features::ChannelIO< Derived >::save	(	std::string	groupName,
		std::string	datasetName,
		const Channel< T > &	channel
	)

Member Data Documentation

m_file_access

template<typename Derived >

Derived* lvr2::hdf5features::ChannelIO< Derived >::m_file_access = static_cast<Derived*>(this)

protected

Definition at line 53 of file hdf5/ChannelIO.hpp.

---

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

• hdf5/ChannelIO.hpp