Main Page Modules Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members Related Pages

syn::WatermarkedQueue Class Template Reference

repository for sample buffers. More...

#include <WatermarkedQueue.h>

Inheritance diagram for syn::WatermarkedQueue:

[legend]Collaboration diagram for syn::WatermarkedQueue:

[legend]List of all members.

Public Methods
	WatermarkedQueue ()
virtual	~WatermarkedQueue ()
void	setHighMark (unsigned int h)
	set the high mark. More...
void	setLowMark (unsigned int l)
	set the low mark. More...
unsigned int	highMark () const
unsigned int	lowMark () const
bool	high () const
	return true if queue is filled to above the high mark. More...
bool	low () const
	return false if queue is filled to below the low mark. More...
bool	empty () const
	return true if this queue is empty. More...
Public Attributes
unsigned int	mLow
unsigned int	mHigh

Detailed Description

template<typename _type> class syn::WatermarkedQueue

repository for sample buffers.

Definition at line 11 of file WatermarkedQueue.h.

Constructor & Destructor Documentation

template<typename _type>

syn::WatermarkedQueue<_type>::WatermarkedQueue<_type> ( ) [inline]

Definition at line 14 of file WatermarkedQueue.h.

template<typename _type>

syn::WatermarkedQueue<_type>::~WatermarkedQueue<_type> ( ) [inline, virtual]

Definition at line 18 of file WatermarkedQueue.h.

Member Function Documentation

template<typename _type>

void syn::WatermarkedQueue<_type>::setHighMark ( unsigned int h ) [inline]

set the high mark.

Definition at line 23 of file WatermarkedQueue.h.

template<typename _type>

void syn::WatermarkedQueue<_type>::setLowMark ( unsigned int l ) [inline]

set the low mark.

Definition at line 29 of file WatermarkedQueue.h.

template<typename _type>

unsigned int syn::WatermarkedQueue<_type>::highMark ( ) const [inline]

Definition at line 34 of file WatermarkedQueue.h.
Referenced by high().

template<typename _type>

unsigned int syn::WatermarkedQueue<_type>::lowMark ( ) const [inline]

Definition at line 35 of file WatermarkedQueue.h.
Referenced by low().

template<typename _type>

bool syn::WatermarkedQueue<_type>::high ( ) const [inline]

return true if queue is filled to above the high mark.

Definition at line 38 of file WatermarkedQueue.h.

template<typename _type>

bool syn::WatermarkedQueue<_type>::low ( ) const [inline]

return false if queue is filled to below the low mark.

Definition at line 41 of file WatermarkedQueue.h.

template<typename _type>

bool syn::WatermarkedQueue<_type>::empty ( ) const [inline]

return true if this queue is empty.

Definition at line 44 of file WatermarkedQueue.h.

Member Data Documentation

template<typename _type>

unsigned int syn::WatermarkedQueue<_type>::mLow

Definition at line 46 of file WatermarkedQueue.h.

template<typename _type>

unsigned int syn::WatermarkedQueue<_type>::mHigh

Definition at line 46 of file WatermarkedQueue.h.

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

/root/src/subsynth/syn/Util/WatermarkedQueue.h

Generated at Mon Apr 15 09:28:09 2002 for subsynth by