Kwave::SampleSource Class Reference

#include <SampleSource.h>

Inheritance diagram for Kwave::SampleSource:

Collaboration diagram for Kwave::SampleSource:

Public Member Functions
	SampleSource (QObject *parent=Q_NULLPTR)
virtual	~SampleSource ()
virtual void	goOn ()=0
virtual bool	done () const
Public Member Functions inherited from Kwave::StreamObject
	StreamObject (QObject *parent=Q_NULLPTR)
virtual	~StreamObject ()
virtual unsigned int	tracks () const
virtual Kwave::StreamObject *	operator[] (unsigned int track)
virtual unsigned int	tracksOfPort (const char *port) const
virtual Kwave::StreamObject *	port (const char *port, unsigned int track)
virtual unsigned int	blockSize () const
void	setAttribute (const char *attribute, const QVariant &value)

Additional Inherited Members
Signals inherited from Kwave::StreamObject
void	attributeChanged (const QVariant value)
Static Public Member Functions inherited from Kwave::StreamObject
static void	setInteractive (bool interactive)

Detailed Description

Definition at line 31 of file SampleSource.h.

Constructor & Destructor Documentation

SampleSource()

Kwave::SampleSource::SampleSource ( QObject *  parent = Q_NULLPTR )

explicit

Constructor

Parameters

parent

a parent object, passed to QObject (optional)

Definition at line 23 of file SampleSource.cpp.

    :Kwave::StreamObject(parent)
{
}

~SampleSource()

Kwave::SampleSource::~SampleSource ( )

virtual

Destructor

Definition at line 29 of file SampleSource.cpp.

{
}

Member Function Documentation

done()

virtual bool Kwave::SampleSource::done ( ) const

inlinevirtual

Returns true if the end of the source has been reached, e.g. at EOF of an input stream. The default implementation always returns false, which means that the source is always able to produce data (useful for signal generators).

Returns

true if it can produce more sample data, otherwise false

Reimplemented in Kwave::MultiTrackSource< SOURCE, INITIALIZE >, Kwave::MultiTrackSource< Kwave::SampleReader, false >, Kwave::MultiTrackSource< SOURCE, false >, and Kwave::SampleReader.

Definition at line 61 of file SampleSource.h.

{ return false; }

goOn()

virtual void Kwave::SampleSource::goOn ( )

pure virtual

Each KwaveSampleSource has to derive this method for producing sample data. It then should emit a signal like this: "output(SampleArray data)"

Implemented in Kwave::ChannelMixer, Kwave::MultiTrackSource< SOURCE, INITIALIZE >, Kwave::MultiTrackSource< Kwave::SampleReader, false >, Kwave::MultiTrackSource< SOURCE, false >, Kwave::SampleReader, Kwave::PitchShiftFilter, Kwave::BandPass, Kwave::Mul, Kwave::RateConverter, Kwave::LowPassFilter, Kwave::NotchFilter, Kwave::CurveStreamAdapter, Kwave::NoiseGenerator, Kwave::Normalizer, Kwave::Delay, and Kwave::Osc.

Referenced by Kwave::FilterPlugin::run().

Here is the caller graph for this function:

---

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

• libkwave/SampleSource.h
• libkwave/SampleSource.cpp