pl-nk v0.4.5
Plonk|Plink|Plank are a set of cross-platform C/C++ frameworks for audio software development
Public Member Functions
BusBuffer< SampleType > Class Template Reference

Enables the storage of globally accessible buffers to be used as signal busses. More...

Inherits SmartPointerContainer< SmartPointerType, enableWeak >.

List of all members.

Public Member Functions

void write (TimeStamp const &timeStamp, const int numSamples, const SampleType *sourceData) throw ()
 Write data with a given time stampe start to the bus.
void read (TimeStamp &timeStamp, const int numSamples, SampleType *destData) throw ()
 Read data from the bus with a given time stamp.

Detailed Description

template<class SampleType>
class BusBuffer< SampleType >

Enables the storage of globally accessible buffers to be used as signal busses.

This stores a time stamped circular buffer such that BusRead units can read from the bus at "any" block size and get enough data to fill their output. Of course this depends on the buffer size being large enough (although the buffer should automatically resize if you try to read in larger chunks than the current buffer size allows).


Member Function Documentation

template<class SampleType >
void BusBuffer< SampleType >::read ( TimeStamp timeStamp,
const int  numSamples,
SampleType *  destData 
) throw () [inline]

Read data from the bus with a given time stamp.

template<class SampleType >
void BusBuffer< SampleType >::write ( TimeStamp const &  timeStamp,
const int  numSamples,
const SampleType *  sourceData 
) throw () [inline]

Write data with a given time stampe start to the bus.


The documentation for this class was generated from the following file:
 All Classes Functions Typedefs Enumerations Enumerator Properties