Helios++
Helios software for LiDAR simulations
helios::filems::SimpleSyncFileFullWaveformWriter Class Reference

Concrete class specializing SimpleSyncFileWriter to write full waveform data directly to a file. More...

#include <SimpleSyncFileFullWaveformWriter.h>

Inheritance diagram for helios::filems::SimpleSyncFileFullWaveformWriter:
Collaboration diagram for helios::filems::SimpleSyncFileFullWaveformWriter:

Public Member Functions

 SimpleSyncFileFullWaveformWriter (const std::string &path, std::ios_base::openmode om=std::ios_base::app)
 Simple synchronous file full waveform writer constructor. More...
 
- Public Member Functions inherited from helios::filems::SimpleSyncFileWriter< FullWaveform const & >
 SimpleSyncFileWriter (const std::string &path, std::ios_base::openmode om=std::ios_base::app)
 Simple synchronous file writer constructor. More...
 
void finish () override
 SimpleSyncFileWriter finish method assures that output file will be closed if it is open.
 
- Public Member Functions inherited from helios::filems::SingleSyncFileWriter< WriteArgs ... >
 SingleSyncFileWriter ()
 Default constructor for synchronous single-file writer.
 
 SingleSyncFileWriter (const std::string &path)
 Instantiate a SingleSyncFileWriter which writes to file at given path. More...
 
void write (WriteArgs ... writeArgs) override
 Synchronously write to a single file. More...
 
std::string getPath (size_t const idx) const override
 Obtain the path to the file. More...
 
- Public Member Functions inherited from helios::filems::SyncFileWriter< WriteArgs ... >
 SyncFileWriter ()=default
 Default constructor for synchronous file writer.
 
std::string getPath ()
 Non index version of the SyncFileWriter::getPath(size_t const) function. More...
 

Additional Inherited Members

- Protected Attributes inherited from helios::filems::SimpleSyncFileWriter< FullWaveform const & >
std::ofstream ofs
 Output file stream to be used by the simple synchronous file writer.
 
- Protected Attributes inherited from helios::filems::SingleSyncFileWriter< WriteArgs ... >
std::string path
 Path to file to be written.
 
std::mutex mutex
 Mutex to synchronize concurrent write operations.
 
std::shared_ptr< WriteStrategy< WriteArgs ... > > writeStrategy
 The write strategy specifying how to write data to file.
 

Detailed Description

Concrete class specializing SimpleSyncFileWriter to write full waveform data directly to a file.

Author
Alberto M. Esmoris Pena
Version
1.0
See also
filems::SimpleSyncFileWriter
filems::DirectFullWaveformWriteStrategy

Constructor & Destructor Documentation

◆ SimpleSyncFileFullWaveformWriter()

helios::filems::SimpleSyncFileFullWaveformWriter::SimpleSyncFileFullWaveformWriter ( const std::string &  path,
std::ios_base::openmode  om = std::ios_base::app 
)
inlineexplicit

Simple synchronous file full waveform writer constructor.

See also
filems::SimpleSyncFileWriter::SimpleSyncFileWriter

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