iso::synth::RingBufferTap Class Reference

tap into ring buffer More...

#include <iso_synth_ring_buffer_tap.h>

Collaboration diagram for iso::synth::RingBufferTap:

[legend]List of all members.

Public Member Functions
	RingBufferTap (const RingBuffer *pRingBuffer)
	parameter based constructor
	RingBufferTap (const RingBuffer *pRingBuffer, const Frame &pTapPosition) throw (SynthException)
	parameter based constructor
	RingBufferTap (const serialize::SerializeData &pSerializeData) throw (serialize::SerializeException)
	serialization based constructor
	~RingBufferTap ()
	destructor
virtual serialize::SerializeData	serialize (const String &pSerialName=sClassName) const
	create serializeData for ring buffer tap
const RingBufferTap &	operator= (const RingBufferTap &pRingBufferTap)
	assignment operator
const Frame &	tapPosition () const
	return tap position
void	setTapPosition (const Frame &pTapPosition) throw (SynthException)
	set tap position
void	changeTapPosition (const Frame &pTapPosition) throw (SynthException)
	change tap position
void	process (Buffer *pBuffer)
	process buffer
void	process (Buffer *pBuffer, Frame *pDelayValues)
	process buffer
void	process (Buffer *pBuffer, Buffer *pDelayValues)
	process buffer
String	info () const
	obtain textual ring buffer tao information
Static Public Member Functions
static serialize::Serializable *	deSerialize (const serialize::SerializeData &pSerializeData) throw (serialize::SerializeException)
	create ring buffer tap from SerializeData
Static Public Attributes
static const String	sClassName
	default name
Protected Attributes
const RingBuffer *	mRingBuffer
	ring buffer
Frame	mTapPosition
	tap position
Friends
std::ostream &	operator<< (std::ostream &pOstream, const RingBufferTap &pRingBufferTap)
	print ring buffer tap information

---

Detailed Description

tap into ring buffer

ring buffer

tap position is relative to front position of ring buffer

Created by Daniel Bisig on 08/15/06.

---

Constructor & Destructor Documentation

RingBufferTap::RingBufferTap

(

const RingBuffer *

pRingBuffer

)

parameter based constructor

Parameters:

pRingBuffer

ring buffer

RingBufferTap::RingBufferTap	(	const RingBuffer *	pRingBuffer,
		const Frame &	pTapPosition
	)			throw (SynthException)

parameter based constructor

Parameters:

	pRingBuffer	ring buffer
	pTapPosition	tap position

Exceptions:

SynthException

channelcount mismatch between ringbuffer and tapPosition

RingBufferTap::RingBufferTap

(

const serialize::SerializeData &

pSerializeData

)

throw (serialize::SerializeException)

serialization based constructor

Parameters:

pSerializeData

serialization data

Exceptions:

SerializeException

failed to create ring buffer tap

RingBufferTap::~RingBufferTap

(

)

destructor

---

Member Function Documentation

serialize::SerializeData RingBufferTap::serialize

(

const String &

pSerialName = sClassName

)

const [virtual]

create serializeData for ring buffer tap

Returns:

serializeData

serialize::Serializable * RingBufferTap::deSerialize

(

const serialize::SerializeData &

pSerializeData

)

throw (serialize::SerializeException) [static]

create ring buffer tap from SerializeData

Parameters:

pSerializeData

SerializeData

Returns:

Serializable

Exceptions:

SerializeException

incompatible SerializeData

const RingBufferTap & RingBufferTap::operator=

(

const RingBufferTap &

pRingBufferTap

)

assignment operator

Parameters:

pRingBufferTap

ring buffer tap to copy properties from

Returns:

RingBufferTap

const Frame & RingBufferTap::tapPosition

(

)

const

return tap position

Returns:

tap position

void RingBufferTap::setTapPosition

(

const Frame &

pTapPosition

)

throw (SynthException)

set tap position

Parameters:

pTapPosition

tap position

Exceptions:

SynthException

channelcount mismatch between ringbuffer and tapPosition

void RingBufferTap::changeTapPosition

(

const Frame &

pTapPosition

)

throw (SynthException)

change tap position

Parameters:

pTapPosition

tap position change

Exceptions:

SynthException

channelcount mismatch between ringbuffer and tapPosition

void RingBufferTap::process

(

Buffer *

pBuffer

)

process buffer

Parameters:

pBuffer

buffer to process

based on ring buffer tap's own internal tap position fill buffer with ring buffer content

void RingBufferTap::process	(	Buffer *	pBuffer,
		Frame *	pDelayValues
	)

process buffer

Parameters:

	pBuffer	buffer to process
	pDelayValues	delay values

based on externally supplied tap position (frame version) -> ignores internal tap position fill buffer with ring buffer content

void RingBufferTap::process	(	Buffer *	pBuffer,
		Buffer *	pDelayValues
	)

process buffer

Parameters:

	pBuffer	buffer to process
	pDelayValues	delay values

based on externally supplied tap position (buffer version) -> ignores internal tap position fill buffer with ring buffer content

String RingBufferTap::info

(

)

const

obtain textual ring buffer tao information

Returns:

String containing ring buffer tap information

---

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	pOstream,
		const RingBufferTap &	pRingBufferTap
	)			[friend]

print ring buffer tap information

---

Member Data Documentation

const String RingBufferTap::sClassName [static]

default name

const RingBuffer* iso::synth::RingBufferTap::mRingBuffer [protected]

ring buffer

Frame iso::synth::RingBufferTap::mTapPosition [protected]

tap position

tap position is either zero or negative and represents a position relative to to ring buffer start position

---

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

• /Users/dbisig/programming/swarms/trunk/synth/trunk/code/core/data/iso_synth_ring_buffer_tap.h
• /Users/dbisig/programming/swarms/trunk/synth/trunk/code/core/data/iso_synth_ring_buffer_tap.cpp

---