psynth::sound::scoped_sample_value< BaseSampleValue, MinVal, MaxVal, ZeroVal > Struct Template Reference

A sample adaptor that modifies the range of the source sample. More...

#include <sample.hpp>

List of all members.

Public Types
typedef scoped_sample_value	value_type
typedef value_type &	reference
typedef value_type *	pointer
typedef const value_type &	const_reference
typedef const value_type *	const_pointer
typedef BaseSampleValue	base_sample
Public Member Functions
	BOOST_STATIC_CONSTANT (bool, is_mutable=sample_traits< BaseSampleValue >::is_mutable)
	scoped_sample_value ()
	scoped_sample_value (const scoped_sample_value &c)
	scoped_sample_value (BaseSampleValue val)
scoped_sample_value &	operator++ ()
scoped_sample_value &	operator-- ()
scoped_sample_value	operator++ (int)
scoped_sample_value	operator-- (int)
template<typename Scalar2 >
scoped_sample_value &	operator+= (Scalar2 v)
template<typename Scalar2 >
scoped_sample_value &	operator-= (Scalar2 v)
template<typename Scalar2 >
scoped_sample_value &	operator*= (Scalar2 v)
template<typename Scalar2 >
scoped_sample_value &	operator/= (Scalar2 v)
scoped_sample_value &	operator= (BaseSampleValue v)
	operator BaseSampleValue () const
Static Public Member Functions
static value_type	min_value ()
static value_type	max_value ()
static value_type	zero_value ()

---

Detailed Description

template<typename BaseSampleValue, typename MinVal, typename MaxVal, typename ZeroVal>
struct psynth::sound::scoped_sample_value< BaseSampleValue, MinVal, MaxVal, ZeroVal >

A sample adaptor that modifies the range of the source sample.

Models: SampleValueConcept

---

Member Typedef Documentation

template<typename BaseSampleValue , typename MinVal , typename MaxVal , typename ZeroVal >

typedef BaseSampleValue psynth::sound::scoped_sample_value< BaseSampleValue, MinVal, MaxVal, ZeroVal >::base_sample

template<typename BaseSampleValue , typename MinVal , typename MaxVal , typename ZeroVal >

typedef const value_type* psynth::sound::scoped_sample_value< BaseSampleValue, MinVal, MaxVal, ZeroVal >::const_pointer

template<typename BaseSampleValue , typename MinVal , typename MaxVal , typename ZeroVal >

typedef const value_type& psynth::sound::scoped_sample_value< BaseSampleValue, MinVal, MaxVal, ZeroVal >::const_reference

template<typename BaseSampleValue , typename MinVal , typename MaxVal , typename ZeroVal >

typedef value_type* psynth::sound::scoped_sample_value< BaseSampleValue, MinVal, MaxVal, ZeroVal >::pointer

template<typename BaseSampleValue , typename MinVal , typename MaxVal , typename ZeroVal >

typedef value_type& psynth::sound::scoped_sample_value< BaseSampleValue, MinVal, MaxVal, ZeroVal >::reference

template<typename BaseSampleValue , typename MinVal , typename MaxVal , typename ZeroVal >

typedef scoped_sample_value psynth::sound::scoped_sample_value< BaseSampleValue, MinVal, MaxVal, ZeroVal >::value_type

---

Constructor & Destructor Documentation

template<typename BaseSampleValue , typename MinVal , typename MaxVal , typename ZeroVal >

psynth::sound::scoped_sample_value< BaseSampleValue, MinVal, MaxVal, ZeroVal >::scoped_sample_value

(

)

[inline]

template<typename BaseSampleValue , typename MinVal , typename MaxVal , typename ZeroVal >

psynth::sound::scoped_sample_value< BaseSampleValue, MinVal, MaxVal, ZeroVal >::scoped_sample_value

(

const scoped_sample_value< BaseSampleValue, MinVal, MaxVal, ZeroVal > &

c

)

[inline]

template<typename BaseSampleValue , typename MinVal , typename MaxVal , typename ZeroVal >

psynth::sound::scoped_sample_value< BaseSampleValue, MinVal, MaxVal, ZeroVal >::scoped_sample_value

(

BaseSampleValue

val

)

[inline]

---

Member Function Documentation

template<typename BaseSampleValue , typename MinVal , typename MaxVal , typename ZeroVal >

psynth::sound::scoped_sample_value< BaseSampleValue, MinVal, MaxVal, ZeroVal >::BOOST_STATIC_CONSTANT	(	bool	,
		is_mutable	= sample_traits< BaseSampleValue >::is_mutable
	)

template<typename BaseSampleValue , typename MinVal , typename MaxVal , typename ZeroVal >

static value_type psynth::sound::scoped_sample_value< BaseSampleValue, MinVal, MaxVal, ZeroVal >::max_value

(

)

[inline, static]

template<typename BaseSampleValue , typename MinVal , typename MaxVal , typename ZeroVal >

static value_type psynth::sound::scoped_sample_value< BaseSampleValue, MinVal, MaxVal, ZeroVal >::min_value

(

)

[inline, static]

template<typename BaseSampleValue , typename MinVal , typename MaxVal , typename ZeroVal >

psynth::sound::scoped_sample_value< BaseSampleValue, MinVal, MaxVal, ZeroVal >::operator BaseSampleValue

(

)

const [inline]

template<typename BaseSampleValue , typename MinVal , typename MaxVal , typename ZeroVal >

template<typename Scalar2 >

scoped_sample_value& psynth::sound::scoped_sample_value< BaseSampleValue, MinVal, MaxVal, ZeroVal >::operator*=

(

Scalar2

v

)

[inline]

template<typename BaseSampleValue , typename MinVal , typename MaxVal , typename ZeroVal >

scoped_sample_value& psynth::sound::scoped_sample_value< BaseSampleValue, MinVal, MaxVal, ZeroVal >::operator++

(

)

[inline]

template<typename BaseSampleValue , typename MinVal , typename MaxVal , typename ZeroVal >

scoped_sample_value psynth::sound::scoped_sample_value< BaseSampleValue, MinVal, MaxVal, ZeroVal >::operator++

(

int

)

[inline]

template<typename BaseSampleValue , typename MinVal , typename MaxVal , typename ZeroVal >

template<typename Scalar2 >

scoped_sample_value& psynth::sound::scoped_sample_value< BaseSampleValue, MinVal, MaxVal, ZeroVal >::operator+=

(

Scalar2

v

)

[inline]

template<typename BaseSampleValue , typename MinVal , typename MaxVal , typename ZeroVal >

scoped_sample_value psynth::sound::scoped_sample_value< BaseSampleValue, MinVal, MaxVal, ZeroVal >::operator--

(

int

)

[inline]

template<typename BaseSampleValue , typename MinVal , typename MaxVal , typename ZeroVal >

scoped_sample_value& psynth::sound::scoped_sample_value< BaseSampleValue, MinVal, MaxVal, ZeroVal >::operator--

(

)

[inline]

template<typename BaseSampleValue , typename MinVal , typename MaxVal , typename ZeroVal >

template<typename Scalar2 >

scoped_sample_value& psynth::sound::scoped_sample_value< BaseSampleValue, MinVal, MaxVal, ZeroVal >::operator-=

(

Scalar2

v

)

[inline]

template<typename BaseSampleValue , typename MinVal , typename MaxVal , typename ZeroVal >

template<typename Scalar2 >

scoped_sample_value& psynth::sound::scoped_sample_value< BaseSampleValue, MinVal, MaxVal, ZeroVal >::operator/=

(

Scalar2

v

)

[inline]

template<typename BaseSampleValue , typename MinVal , typename MaxVal , typename ZeroVal >

scoped_sample_value& psynth::sound::scoped_sample_value< BaseSampleValue, MinVal, MaxVal, ZeroVal >::operator=

(

BaseSampleValue

v

)

[inline]

template<typename BaseSampleValue , typename MinVal , typename MaxVal , typename ZeroVal >

static value_type psynth::sound::scoped_sample_value< BaseSampleValue, MinVal, MaxVal, ZeroVal >::zero_value

(

)

[inline, static]

---

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

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