HBreaker< T > Class Template Reference

#include <hbreaker.h>

Inheritance diagram for HBreaker< T >:

Collaboration diagram for HBreaker< T >:

Public Member Functions
	HBreaker (HWriter< T > *writer, bool off, size_t blocksize)
	HBreaker (HWriterConsumer< T > *consumer, bool off, size_t blocksize)
	HBreaker (HReader< T > *reader, bool off, size_t blocksize)
	~HBreaker ()
virtual void	Filter (T *src, T *dest, size_t blocksize)
void	SetOff (bool off)
bool	GetOff ()
bool	Start ()
bool	Stop ()
int	Write (T *src, size_t blocksize)
int	Read (T *dest, size_t blocksize)
Public Member Functions inherited from HFilter< T >
	~HFilter ()
int	Write (T *src, size_t blocksize)
int	Read (T *dest, size_t blocksize)
bool	Start ()
bool	Stop ()
bool	Command (HCommand *command)
void	Enable ()
void	Disable ()
bool	GetEnabled ()
Public Member Functions inherited from HObject
	HObject ()
Public Member Functions inherited from HWriter< T >
virtual	~HWriter ()=default
HWriter< T > *	Writer ()
Public Member Functions inherited from HReader< T >
virtual	~HReader ()=default
HReader< T > *	Reader ()
Public Member Functions inherited from HWriterConsumer< T >
HWriterConsumer< T > *	Consumer ()

Additional Inherited Members
Static Public Member Functions inherited from HFilter< T >
static std::vector< float >	ReadCoeffsFromFile (std::string filename)
static std::vector< float >	ReadCoeffsFromFile (char *filename)
Protected Member Functions inherited from HFilter< T >
	HFilter (HWriter< T > *writer, size_t blocksize, HProbe< T > *probe=NULL)
	HFilter (HWriterConsumer< T > *consumer, size_t blocksize, HProbe< T > *probe=NULL)
	HFilter (HReader< T > *reader, size_t blocksize, HProbe< T > *probe=NULL)
void	SetWriter (HWriter< T > *writer)
Protected Attributes inherited from HFilter< T >
int	_blocksize

Detailed Description

template<class T>
class HBreaker< T >

A filter that can be made to discard all samples. When switched off, reads will return zero samples and writes will silently discard the samples.

When the component is switched off, Stop() will be called on the up- or downstream writer or reader. And when switched on, Start() will be called.

Constructor & Destructor Documentation

HBreaker() [1/3]

template<class T >

HBreaker< T >::HBreaker	(	HWriter< T > *	writer,
		bool	off,
		size_t	blocksize
	)

Construct a new HBreaker object that writes to a writer

HBreaker() [2/3]

template<class T >

HBreaker< T >::HBreaker	(	HWriterConsumer< T > *	consumer,
		bool	off,
		size_t	blocksize
	)

Construct a new HBreaker object that registers with an upstream writer

HBreaker() [3/3]

template<class T >

HBreaker< T >::HBreaker	(	HReader< T > *	reader,
		bool	off,
		size_t	blocksize
	)

Construct a new HBreaker object that reads from a reader

~HBreaker()

template<class T >

HBreaker< T >::~HBreaker

Default destructor

Member Function Documentation

Filter()

template<class T >

void HBreaker< T >::Filter ( T *  src, T *  dest, size_t  blocksize  )

virtual

Run a block of samples through the mute filter

Implements HFilter< T >.

GetOff()

template<class T >

bool HBreaker< T >::GetOff ( )

inline

Get state

Read()

template<class T >

int HBreaker< T >::Read ( T *  dest, size_t  blocksize  )

inlinevirtual

Read a block of samples

Implements HReader< T >.

SetOff()

template<class T >

void HBreaker< T >::SetOff

(

bool

off

)

Set state

Start()

template<class T >

bool HBreaker< T >::Start

virtual

Initialize before first write

Reimplemented from HReader< T >.

Stop()

template<class T >

bool HBreaker< T >::Stop

virtual

Cleanup after last write

Reimplemented from HReader< T >.

Write()

template<class T >

int HBreaker< T >::Write ( T *  src, size_t  blocksize  )

inlinevirtual

Write a block of samples

Implements HWriter< T >.

---

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

• /home/henrik/Git/Hardt/hardt/libhardt/include/hbreaker.h
• /home/henrik/Git/Hardt/hardt/libhardt/filters/hbreaker.cpp