lvr2::Channel< T > Class Template Reference

#include <Channel.hpp>

Public Types
using	DataPtr = boost::shared_array< T >
using	DataType = T
using	Optional = boost::optional< Channel< T > >
using	Ptr = std::shared_ptr< Channel< T > >

Public Member Functions
	Channel ()
	Channel (size_t n, size_t width)
	Channel (size_t n, size_t width, DataPtr ptr)
Channel< T >	clone () const
const DataPtr	dataPtr () const
DataPtr	dataPtr ()
size_t	numElements () const
ElementProxy< T >	operator[] (const unsigned &idx)
const ElementProxy< T >	operator[] (const unsigned &idx) const
size_t	width () const

Protected Attributes
DataPtr	m_data
size_t	m_elementWidth
size_t	m_numElements

Friends
std::ostream &	operator<< (std::ostream &os, const Channel< T > &ch)

Detailed Description

template<typename T>
class lvr2::Channel< T >

Definition at line 42 of file Channel.hpp.

Member Typedef Documentation

DataPtr

template<typename T>

using lvr2::Channel< T >::DataPtr = boost::shared_array<T>

Definition at line 48 of file Channel.hpp.

DataType

template<typename T>

using lvr2::Channel< T >::DataType = T

Definition at line 47 of file Channel.hpp.

Optional

template<typename T>

using lvr2::Channel< T >::Optional = boost::optional<Channel<T> >

Definition at line 45 of file Channel.hpp.

Ptr

template<typename T>

using lvr2::Channel< T >::Ptr = std::shared_ptr<Channel<T> >

Definition at line 46 of file Channel.hpp.

Constructor & Destructor Documentation

Channel() [1/3]

template<typename T>

lvr2::Channel< T >::Channel

(

)

Channel() [2/3]

template<typename T>

lvr2::Channel< T >::Channel	(	size_t	n,
		size_t	width
	)

Channel() [3/3]

template<typename T>

lvr2::Channel< T >::Channel	(	size_t	n,
		size_t	width,
		DataPtr	ptr
	)

Member Function Documentation

clone()

template<typename T>

Channel<T> lvr2::Channel< T >::clone

(

)

const

dataPtr() [1/2]

template<typename T>

const DataPtr lvr2::Channel< T >::dataPtr

(

)

const

dataPtr() [2/2]

template<typename T>

DataPtr lvr2::Channel< T >::dataPtr

(

)

numElements()

template<typename T>

size_t lvr2::Channel< T >::numElements

(

)

const

operator[]() [1/2]

template<typename T>

ElementProxy<T> lvr2::Channel< T >::operator[]

(

const unsigned &

idx

)

operator[]() [2/2]

template<typename T>

const ElementProxy<T> lvr2::Channel< T >::operator[]

(

const unsigned &

idx

)

const

width()

template<typename T>

size_t lvr2::Channel< T >::width

(

)

const

Friends And Related Function Documentation

operator<<

template<typename T>

std::ostream& operator<< ( std::ostream &  os, const Channel< T > &  ch  )

friend

Definition at line 66 of file Channel.hpp.

Member Data Documentation

m_data

template<typename T>

DataPtr lvr2::Channel< T >::m_data

protected

Definition at line 75 of file Channel.hpp.

m_elementWidth

template<typename T>

size_t lvr2::Channel< T >::m_elementWidth

protected

Definition at line 74 of file Channel.hpp.

m_numElements

template<typename T>

size_t lvr2::Channel< T >::m_numElements

protected

Definition at line 73 of file Channel.hpp.

---

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

• Channel.hpp