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

#include <hfilewriter.h>

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

Public Member Functions

 HFileWriter (const char *filename, bool sequence=false)
 
 HFileWriter (const std::string filename, bool sequence=false)
 
 HFileWriter (const char *filename, HWriterConsumer< T > *consumer, bool sequence=false)
 
 HFileWriter (const std::string filename, HWriterConsumer< T > *consumer, bool sequence=false)
 
virtual int Write (T *src, size_t blocksize)
 
bool Start ()
 
bool Stop ()
 
void Seek (int bytes)
 
bool Command (HCommand *command)
 
- Public Member Functions inherited from HWriter< T >
virtual ~HWriter ()=default
 
HWriter< T > * Writer ()
 
- Public Member Functions inherited from HObject
 HObject ()
 

Detailed Description

template<class T>
class HFileWriter< T >

Write to a file

Constructor & Destructor Documentation

◆ HFileWriter() [1/4]

template<class T >
HFileWriter< T >::HFileWriter ( const char *  filename,
bool  sequence = false 
)
inline

Construct a new HFileWriter with the given filename

◆ HFileWriter() [2/4]

template<class T >
HFileWriter< T >::HFileWriter ( const std::string  filename,
bool  sequence = false 
)
inline

Construct a new HFileWriter with the given filename

◆ HFileWriter() [3/4]

template<class T >
HFileWriter< T >::HFileWriter ( const char *  filename,
HWriterConsumer< T > *  consumer,
bool  sequence = false 
)
inline

Construct a new HFileWriter with the given filename and register with the given consumer

◆ HFileWriter() [4/4]

template<class T >
HFileWriter< T >::HFileWriter ( const std::string  filename,
HWriterConsumer< T > *  consumer,
bool  sequence = false 
)
inline

Construct a new HFileWriter with the given filename and register with the given consumer

Member Function Documentation

◆ Command()

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

Execute or carry through a command

Implements HWriter< T >.

Reimplemented in HWavWriter< T >.

◆ Seek()

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

Seek to this position in the file

◆ Start()

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

Initialize before first write

Reimplemented from HWriter< T >.

Reimplemented in HWavWriter< T >.

◆ Stop()

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

Cleanup after last write

Reimplemented from HWriter< T >.

Reimplemented in HWavWriter< T >.

◆ Write()

template<class T >
virtual int HFileWriter< T >::Write ( T *  src,
size_t  blocksize 
)
inlinevirtual

Write to the file

Implements HWriter< T >.

Reimplemented in HProbe< Tout >, HProbe< T >, HWavWriter< T >, and HProbe< std::complex< T > >.


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