csl::Window Class Reference

#include <Window.h>

Inheritance diagram for csl::Window:

List of all members.

---

Detailed Description

Window; The superclass of all other window function classes in CSL. Subclasses need only to implement the fillWindow(); and the Constructors.

Public Member Functions
	Window ()
	Window (unsigned windowSize, float gain=1)
	~Window ()
	clean-up . . . free the allocated buffer that held the window data.
void	setSize (unsigned windowSize)
	Set the number of samples the window spans.
void	setGain (float gain)
	Set the gain to which the window should be normalized.
sample *	window ()
void	nextBuffer (Buffer &outputBuffer, unsigned outBufNum) throw (CException)
	Returns a pointer to the window data.
void	dump ()
	Print some info about the window.
Protected Member Functions
virtual void	fillWindow ()
	subclasses override this to fill the buffer with corresponding function.
Protected Attributes
Buffer	mWindowBuffer
	used to store the window
unsigned	mWindowBufferPos
	where am I in the window buffer
unsigned	mWindowSize
	length in samples of the window
float	mGain
	gain for the window

---

Constructor & Destructor Documentation

Window::Window (   )

Creates a window using the default Gestalt size and a gain of 1; Creates a window (hann) with the specified size and gain (gain is optional).

Window::Window (  unsigned  windowSize, float  gain = 1 )

Window::~Window (   )

clean-up . . . free the allocated buffer that held the window data.

---

Member Function Documentation

void Window::setSize (  unsigned  windowSize  )

Set the number of samples the window spans.

void Window::setGain (  float  gain  )

Set the gain to which the window should be normalized.

sample* csl::Window::window (   )  [inline]

void Window::nextBuffer (  Buffer &  outputBuffer, unsigned  outBufNum )  throw (CException)

Returns a pointer to the window data. get everything into registers

void Window::dump (   )

Print some info about the window.

void Window::fillWindow (   )  [protected, virtual]

subclasses override this to fill the buffer with corresponding function. Reimplemented in csl::RectangularWindow, csl::HammingWindow, csl::HannWindow, csl::BlackmanWindow, csl::BlackmanHarrisWindow, and csl::WelchWindow.

---

Member Data Documentation

Buffer csl::Window::mWindowBuffer [protected]

used to store the window

unsigned csl::Window::mWindowBufferPos [protected]

where am I in the window buffer

unsigned csl::Window::mWindowSize [protected]

length in samples of the window

float csl::Window::mGain [protected]

gain for the window

---

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

• CSL/Sources/Window.h
• CSL/Sources/Window.cpp

---