psynth::sound::planar_frame_reference< SampleReference, ChannelSpace > Struct Template Reference

FrameBasedModel. More...

#include <planar_frame_reference.hpp>

List of all members.

Public Types
typedef detail::homogeneous_channel_base < SampleReference, layout < ChannelSpace > , boost::mpl::size < ChannelSpace >::value >	parent_type
typedef frame< sample_type, layout< ChannelSpace > >	value_type
typedef planar_frame_reference	reference
typedef planar_frame_reference < sample_const_reference, ChannelSpace >	const_reference
Public Member Functions
	BOOST_STATIC_CONSTANT (bool, is_mutable=sample_traits< SampleReference >::is_mutable)
	planar_frame_reference (SampleReference v0, SampleReference v1)
	planar_frame_reference (SampleReference v0, SampleReference v1, SampleReference v2)
	planar_frame_reference (SampleReference v0, SampleReference v1, SampleReference v2, SampleReference v3)
	planar_frame_reference (SampleReference v0, SampleReference v1, SampleReference v2, SampleReference v3, SampleReference v4)
	planar_frame_reference (SampleReference v0, SampleReference v1, SampleReference v2, SampleReference v3, SampleReference v4, SampleReference v5)
template<typename P >
	planar_frame_reference (const P &p)
template<typename SampleV , typename Mapping >
	planar_frame_reference (frame< SampleV, layout< ChannelSpace, Mapping > > &p)
template<typename SamplePtr >
	planar_frame_reference (const planar_frame_iterator< SamplePtr, ChannelSpace > &p, std::ptrdiff_t diff)
const planar_frame_reference &	operator= (const planar_frame_reference &p) const
template<typename P >
const planar_frame_reference &	operator= (const P &p) const
template<typename P >
bool	operator== (const P &p) const
template<typename P >
bool	operator!= (const P &p) const
SampleReference	operator[] (std::size_t i) const
const planar_frame_reference *	operator-> () const

---

Detailed Description

template<typename SampleReference, typename ChannelSpace>
struct psynth::sound::planar_frame_reference< SampleReference, ChannelSpace >

FrameBasedModel.

A reference proxy to a planar frame. Models: HomogeneousChannelBaseConcept, HomogeneousFrameConcept

A reference to a planar frame is a proxy class containing references to each of the corresponding samples.

---

Member Typedef Documentation

template<typename SampleReference, typename ChannelSpace>

typedef planar_frame_reference<sample_const_reference, ChannelSpace> psynth::sound::planar_frame_reference< SampleReference, ChannelSpace >::const_reference

template<typename SampleReference, typename ChannelSpace>

typedef detail::homogeneous_channel_base< SampleReference, layout<ChannelSpace>, boost::mpl::size<ChannelSpace>::value> psynth::sound::planar_frame_reference< SampleReference, ChannelSpace >::parent_type

template<typename SampleReference, typename ChannelSpace>

typedef planar_frame_reference psynth::sound::planar_frame_reference< SampleReference, ChannelSpace >::reference

template<typename SampleReference, typename ChannelSpace>

typedef frame<sample_type, layout<ChannelSpace> > psynth::sound::planar_frame_reference< SampleReference, ChannelSpace >::value_type

---

Constructor & Destructor Documentation

template<typename SampleReference, typename ChannelSpace>

psynth::sound::planar_frame_reference< SampleReference, ChannelSpace >::planar_frame_reference	(	SampleReference	v0,
		SampleReference	v1
	)		[inline]

template<typename SampleReference, typename ChannelSpace>

psynth::sound::planar_frame_reference< SampleReference, ChannelSpace >::planar_frame_reference	(	SampleReference	v0,
		SampleReference	v1,
		SampleReference	v2
	)		[inline]

template<typename SampleReference, typename ChannelSpace>

psynth::sound::planar_frame_reference< SampleReference, ChannelSpace >::planar_frame_reference	(	SampleReference	v0,
		SampleReference	v1,
		SampleReference	v2,
		SampleReference	v3
	)		[inline]

template<typename SampleReference, typename ChannelSpace>

psynth::sound::planar_frame_reference< SampleReference, ChannelSpace >::planar_frame_reference	(	SampleReference	v0,
		SampleReference	v1,
		SampleReference	v2,
		SampleReference	v3,
		SampleReference	v4
	)		[inline]

template<typename SampleReference, typename ChannelSpace>

psynth::sound::planar_frame_reference< SampleReference, ChannelSpace >::planar_frame_reference	(	SampleReference	v0,
		SampleReference	v1,
		SampleReference	v2,
		SampleReference	v3,
		SampleReference	v4,
		SampleReference	v5
	)		[inline]

template<typename SampleReference, typename ChannelSpace>

template<typename P >

psynth::sound::planar_frame_reference< SampleReference, ChannelSpace >::planar_frame_reference

(

const P &

p

)

[inline]

template<typename SampleReference, typename ChannelSpace>

template<typename SampleV , typename Mapping >

psynth::sound::planar_frame_reference< SampleReference, ChannelSpace >::planar_frame_reference

(

frame< SampleV, layout< ChannelSpace, Mapping > > &

p

)

[inline]

template<typename SampleReference, typename ChannelSpace>

template<typename SamplePtr >

psynth::sound::planar_frame_reference< SampleReference, ChannelSpace >::planar_frame_reference	(	const planar_frame_iterator< SamplePtr, ChannelSpace > &	p,
		std::ptrdiff_t	diff
	)		[inline]

---

Member Function Documentation

template<typename SampleReference, typename ChannelSpace>

psynth::sound::planar_frame_reference< SampleReference, ChannelSpace >::BOOST_STATIC_CONSTANT	(	bool	,
		is_mutable	= sample_traits< SampleReference >::is_mutable
	)

template<typename SampleReference, typename ChannelSpace>

template<typename P >

bool psynth::sound::planar_frame_reference< SampleReference, ChannelSpace >::operator!=

(

const P &

p

)

const [inline]

template<typename SampleReference, typename ChannelSpace>

const planar_frame_reference* psynth::sound::planar_frame_reference< SampleReference, ChannelSpace >::operator->

(

)

const [inline]

template<typename SampleReference, typename ChannelSpace>

const planar_frame_reference& psynth::sound::planar_frame_reference< SampleReference, ChannelSpace >::operator=

(

const planar_frame_reference< SampleReference, ChannelSpace > &

p

)

const [inline]

template<typename SampleReference, typename ChannelSpace>

template<typename P >

const planar_frame_reference& psynth::sound::planar_frame_reference< SampleReference, ChannelSpace >::operator=

(

const P &

p

)

const [inline]

template<typename SampleReference, typename ChannelSpace>

template<typename P >

bool psynth::sound::planar_frame_reference< SampleReference, ChannelSpace >::operator==

(

const P &

p

)

const [inline]

template<typename SampleReference, typename ChannelSpace>

SampleReference psynth::sound::planar_frame_reference< SampleReference, ChannelSpace >::operator[]

(

std::size_t

i

)

const [inline]

---

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

• /home/raskolnikov/dev/psynth/trunk/src/psynth/sound/planar_frame_reference.hpp