HCollector< T > Class Template Reference

#include <hcollector.h>

Inheritance diagram for HCollector< T >:

Collaboration diagram for HCollector< T >:

Public Member Functions
	HCollector (HWriter< T > *writer, size_t blocksizeIn, size_t blocksizeOut, HProbe< T > *probe=nullptr)
	HCollector (HWriterConsumer< T > *consumer, size_t blocksizeIn, size_t blocksizeOut, HProbe< T > *probe=nullptr)
	HCollector (HReader< T > *reader, size_t blocksizeIn, size_t blocksizeOut, HProbe< T > *probe=nullptr)
void	SetWriter (HWriter< T > *writer)
	~HCollector ()
int	Write (T *src, size_t blocksize)
int	Read (T *dest, size_t blocksize)
bool	Start ()
bool	Stop ()
bool	Command (HCommand *command)
Public Member Functions inherited from HReader< T >
virtual	~HReader ()=default
HReader< T > *	Reader ()
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 HWriterConsumer< T >
HWriterConsumer< T > *	Consumer ()

Detailed Description

template<class T>
class HCollector< T >

Implements a component that collects blocks of samples untill a requested size has been reached. All collected samples are then written or returned to the upstream reader.

Usefull if you are using a converter that lowers the blocksize, but would prefer to use the same blocksize through the entire chain.

Constructor & Destructor Documentation

HCollector() [1/3]

template<class T >

HCollector< T >::HCollector	(	HWriter< T > *	writer,
		size_t	blocksizeIn,
		size_t	blocksizeOut,
		HProbe< T > *	probe = nullptr
	)

Construct a new HCollector that handle writers

Parameters

writer	The downstream writer
blocksizeIn	Input blocksize
blocksizeOut	Output blocksize
probe	Probe

HCollector() [2/3]

template<class T >

HCollector< T >::HCollector	(	HWriterConsumer< T > *	consumer,
		size_t	blocksizeIn,
		size_t	blocksizeOut,
		HProbe< T > *	probe = nullptr
	)

Construct a new HCollector that handle writer consumers

Parameters

consumer	The upstream consumer
blocksizeIn	Input blocksize
blocksizeOut	Output blocksize
probe	Probe

HCollector() [3/3]

template<class T >

HCollector< T >::HCollector	(	HReader< T > *	reader,
		size_t	blocksizeIn,
		size_t	blocksizeOut,
		HProbe< T > *	probe = nullptr
	)

Construct a new HCollector that handle readers

Parameters

reader	The upstream reader
blocksizeIn	Input blocksize
blocksizeOut	Output blocksize
probe	Probe

~HCollector()

template<class T >

HCollector< T >::~HCollector

Default destructor

Member Function Documentation

Command()

template<class T >

bool HCollector< T >::Command ( HCommand *  command )

inlinevirtual

Execute or carry through a command

Parameters

command

The command

Implements HReader< T >.

Read()

template<class T >

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

virtual

Read a block of samples

Parameters

dest	Destination buffer
blocksize	Number of samples to read

Returns

The number of samples read

Implements HReader< T >.

SetWriter()

template<class T >

void HCollector< T >::SetWriter ( HWriter< T > *  writer )

virtual

Implements HWriterConsumer::SetWriter()

Implements HWriterConsumer< T >.

Start()

template<class T >

bool HCollector< T >::Start

virtual

Call Start() on up- or downstream component

Reimplemented from HReader< T >.

Stop()

template<class T >

bool HCollector< T >::Stop

virtual

Call Stop() on up- or downstream component

Reimplemented from HReader< T >.

Write()

template<class T >

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

virtual

Write a block of samples

Parameters

src	Source buffer
blocksize	Number of samples in the buffer

Returns

Number of samples written

Implements HWriter< T >.

---

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

• /home/henrik/Git/Hardt/hardt/libhardt/include/hcollector.h
• /home/henrik/Git/Hardt/hardt/libhardt/components/hcollector.cpp