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

#include <hstreamprocessor.h>

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

Public Member Functions

 HStreamProcessor (HWriter< T > *writer, HReader< T > *reader, int blocksize, bool *terminationToken)
 
 HStreamProcessor (HReader< T > *reader, int blocksize, bool *terminationToken)
 
void Run (long unsigned int blocks=0)
 
bool Command (H_COMMAND_CLASS commandClass, H_COMMAND_OPCODE commandOpcode, int16_t length, HCommandData data)
 
- Public Member Functions inherited from HProcessor< T >
int Read (T *dest, int blocksize)
 
int Write (T *src, int blocksize)
 
HReader< T > * GetReader ()
 
HWriter< T > * GetWriter ()
 
virtual void Halt ()
 
bool Command (H_COMMAND_CLASS commandClass, H_COMMAND_OPCODE commandOpcode, int32_t value)
 
bool Command (H_COMMAND_CLASS commandClass, H_COMMAND_OPCODE commandOpcode, int16_t length, void *content)
 
bool Command (H_COMMAND_CLASS commandClass, H_COMMAND_OPCODE commandOpcode, bool state)
 
HMetricsGetMetrics ()
 
- Public Member Functions inherited from HWriterConsumer< T >
HWriterConsumer< T > * Consumer ()
 
- Public Member Functions inherited from HObject
 HObject ()
 

Additional Inherited Members

- Protected Member Functions inherited from HProcessor< T >
 HProcessor (HWriter< T > *writer, HReader< T > *reader, size_t blocksize, bool *terminationToken)
 
 HProcessor (HReader< T > *reader, size_t blocksize, bool *terminationToken)
 
 ~HProcessor ()
 
void SetWriter (HWriter< T > *writer)
 
- Protected Attributes inherited from HProcessor< T >
HWriter< T > * _writer
 
HReader< T > * _reader
 

Detailed Description

template<class T>
class HStreamProcessor< T >

Read samples from a local reader and write them to a local writer

Examples
main.cpp, readers_and_consumers.cpp, readers_and_writers.cpp, saq.cpp, and simple.cpp.

Constructor & Destructor Documentation

◆ HStreamProcessor() [1/2]

template<class T >
HStreamProcessor< T >::HStreamProcessor ( HWriter< T > *  writer,
HReader< T > *  reader,
int  blocksize,
bool *  terminationToken 
)

Construct a new HStreamProcessor

◆ HStreamProcessor() [2/2]

template<class T >
HStreamProcessor< T >::HStreamProcessor ( HReader< T > *  reader,
int  blocksize,
bool *  terminationToken 
)

Construct a new HStreamProcessor which will have the writer registered by a later writer, following the HWriterConsumer scheme

Member Function Documentation

◆ Command()

template<class T >
bool HStreamProcessor< T >::Command ( H_COMMAND_CLASS  commandClass,
H_COMMAND_OPCODE  commandOpcode,
int16_t  length,
HCommandData  data 
)
inlinevirtual

Send a command

Implements HProcessor< T >.

◆ Run()

template<class T >
void HStreamProcessor< T >::Run ( long unsigned int  blocks = 0)
virtual

Run the processor

Reimplemented from HProcessor< T >.


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