lvr2::ChannelIO< FeatureBase > Class Template Reference

#include <ChannelIO.hpp>

Public Member Functions
DoubleChannelOptional	loadDoubleChannel (std::string groupName, std::string datasetName)
FloatChannelOptional	loadFloatChannel (std::string groupName, std::string datasetName)
IndexChannelOptional	loadIndexChannel (std::string groupName, std::string datasetName)
UCharChannelOptional	loadUCharChannel (std::string groupName, std::string datasetName)
void	saveDoubleChannel (std::string groupName, std::string datasetName, DoubleChannel &channel)
void	saveFloatChannel (std::string groupName, std::string datasetName, FloatChannel &channel)
void	saveIndexChannel (std::string groupName, std::string datasetName, UCharChannel &channel)
void	saveUCharChannel (std::string groupName, std::string datasetName, UCharChannel &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...
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
FeatureBase *	m_featureBase = static_cast<FeatureBase*>(this)

Detailed Description

template<typename FeatureBase>
class lvr2::ChannelIO< FeatureBase >

Definition at line 14 of file descriptions/ChannelIO.hpp.

Member Function Documentation

addChannel() [1/4]

template<typename FeatureBase>

template<typename T >

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

protected

addChannel() [2/4]

template<typename FeatureBase>

virtual bool lvr2::ChannelIO< FeatureBase >::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

addChannel() [3/4]

template<typename FeatureBase>

virtual bool lvr2::ChannelIO< FeatureBase >::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

addChannel() [4/4]

template<typename FeatureBase>

virtual bool lvr2::ChannelIO< FeatureBase >::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

getChannel() [1/3]

template<typename FeatureBase>

virtual bool lvr2::ChannelIO< FeatureBase >::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

getChannel() [2/3]

template<typename FeatureBase>

virtual bool lvr2::ChannelIO< FeatureBase >::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

getChannel() [3/3]

template<typename FeatureBase>

virtual bool lvr2::ChannelIO< FeatureBase >::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

loadDoubleChannel()

template<typename FeatureBase>

DoubleChannelOptional lvr2::ChannelIO< FeatureBase >::loadDoubleChannel	(	std::string	groupName,
		std::string	datasetName
	)

loadFloatChannel()

template<typename FeatureBase>

FloatChannelOptional lvr2::ChannelIO< FeatureBase >::loadFloatChannel	(	std::string	groupName,
		std::string	datasetName
	)

loadIndexChannel()

template<typename FeatureBase>

IndexChannelOptional lvr2::ChannelIO< FeatureBase >::loadIndexChannel	(	std::string	groupName,
		std::string	datasetName
	)

loadUCharChannel()

template<typename FeatureBase>

UCharChannelOptional lvr2::ChannelIO< FeatureBase >::loadUCharChannel	(	std::string	groupName,
		std::string	datasetName
	)

saveDoubleChannel()

template<typename FeatureBase>

void lvr2::ChannelIO< FeatureBase >::saveDoubleChannel	(	std::string	groupName,
		std::string	datasetName,
		DoubleChannel &	channel
	)

saveFloatChannel()

template<typename FeatureBase>

void lvr2::ChannelIO< FeatureBase >::saveFloatChannel	(	std::string	groupName,
		std::string	datasetName,
		FloatChannel &	channel
	)

saveIndexChannel()

template<typename FeatureBase>

void lvr2::ChannelIO< FeatureBase >::saveIndexChannel	(	std::string	groupName,
		std::string	datasetName,
		UCharChannel &	channel
	)

saveUCharChannel()

template<typename FeatureBase>

void lvr2::ChannelIO< FeatureBase >::saveUCharChannel	(	std::string	groupName,
		std::string	datasetName,
		UCharChannel &	channel
	)

Member Data Documentation

m_featureBase

template<typename FeatureBase>

FeatureBase* lvr2::ChannelIO< FeatureBase >::m_featureBase = static_cast<FeatureBase*>(this)

protected

Definition at line 29 of file descriptions/ChannelIO.hpp.

---

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

• descriptions/ChannelIO.hpp