HARDT - The Ham Radio DSP Toolkit
Public Member Functions | List of all members
HInputWriter< T > Class Template Reference

#include <hinputwriter.h>

Inheritance diagram for HInputWriter< T >:
Inheritance graph
[legend]
Collaboration diagram for HInputWriter< T >:
Collaboration graph
[legend]

Public Member Functions

 HInputWriter (HWriter< T > *writer, bool autostart=true)
 
 HInputWriter (bool autostart=true)
 
int Write (T *src, size_t blocksize)
 
void SetWriter (HWriter< T > *writer)
 
bool Start ()
 
bool Stop ()
 
bool Command (HCommand *command)
 
- Public Member Functions inherited from HWriter< T >
virtual ~HWriter ()=default
 
HWriter< T > * Writer ()
 
- Public Member Functions inherited from HObject
 HObject ()
 
- Public Member Functions inherited from HWriterConsumer< T >
HWriterConsumer< T > * Consumer ()
 

Detailed Description

template<class T>
class HInputWriter< T >

Write to a downstream writer without having any upstream chain components (direct input of samples to a chain of writers)

Constructor & Destructor Documentation

◆ HInputWriter() [1/2]

template<class T >
HInputWriter< T >::HInputWriter ( HWriter< T > *  writer,
bool  autostart = true 
)
inline

Construct a new HInputWriter with a downstream writer

Arguments: writer = A downstream writer autostart = Set to true to make the input-writer call Start() on the downstream writer on first Write(..)

◆ HInputWriter() [2/2]

template<class T >
HInputWriter< T >::HInputWriter ( bool  autostart = true)
inline

Construct a new HInputWriter

Arguments: autostart = Set to true to make the input-writer call Start() on the downstream writer on first Write(..)

Member Function Documentation

◆ Command()

template<class T >
bool HInputWriter< T >::Command ( HCommand command)
inlinevirtual

Execute and/or pass on a command

Implements HWriter< T >.

◆ SetWriter()

template<class T >
void HInputWriter< T >::SetWriter ( HWriter< T > *  writer)
inlinevirtual

◆ Start()

template<class T >
bool HInputWriter< T >::Start ( )
inlinevirtual

Call Start() on downstream components

Reimplemented from HWriter< T >.

◆ Stop()

template<class T >
bool HInputWriter< T >::Stop ( )
inlinevirtual

Call Stop() on up- or downstream components

Reimplemented from HWriter< T >.

◆ Write()

template<class T >
int HInputWriter< 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 file: