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

#include <hfilereader.h>

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

Public Member Functions

 HFileReader (const char *filename, HProbe< T > *probe=nullptr)
 
 HFileReader (const std::string filename, HProbe< T > *probe=nullptr)
 
virtual int Read (T *dest, size_t blocksize)
 
bool Start ()
 
bool Stop ()
 
void Seek (int bytes)
 
bool Command (HCommand *command)
 
- Public Member Functions inherited from HReader< T >
virtual ~HReader ()=default
 
HReader< T > * Reader ()
 
- Public Member Functions inherited from HObject
 HObject ()
 

Detailed Description

template<class T>
class HFileReader< T >

Read from a file

Constructor & Destructor Documentation

◆ HFileReader() [1/2]

template<class T >
HFileReader< T >::HFileReader ( const char *  filename,
HProbe< T > *  probe = nullptr 
)
inline

Construct a new HFileReader

◆ HFileReader() [2/2]

template<class T >
HFileReader< T >::HFileReader ( const std::string  filename,
HProbe< T > *  probe = nullptr 
)
inline

Construct a new HFileReader

Member Function Documentation

◆ Command()

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

Execute and/or pass on a command

Implements HReader< T >.

Reimplemented in HWavReader< T >.

◆ Read()

template<class T >
virtual int HFileReader< T >::Read ( T *  dest,
size_t  blocksize 
)
inlinevirtual

Read a block of samples

Implements HReader< T >.

◆ Seek()

template<class T >
void HFileReader< T >::Seek ( int  bytes)
inline

Seek to this position in the file

◆ Start()

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

Initialize before first read

Reimplemented from HReader< T >.

Reimplemented in HWavReader< T >.

◆ Stop()

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

Cleanup after last read

Reimplemented from HReader< T >.


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