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

Concrete class specializing ZipSyncFileWriter to write a vector of full waveform to a zip file. More...

#include <ZipVectorialSyncFileFullWaveformWriter.h>

Inheritance diagram for helios::filems::ZipVectorialSyncFileFullWaveformWriter:
Collaboration diagram for helios::filems::ZipVectorialSyncFileFullWaveformWriter:

Public Member Functions

 ZipVectorialSyncFileFullWaveformWriter (const string &path, int compressionMode=boost::iostreams::zlib::best_compression)
 ZIP synchronous file full waveform vector writer constructor. More...
 
- Public Member Functions inherited from helios::filems::ZipSyncFileWriter< vector< FullWaveform > const & >
 ZipSyncFileWriter (const string &path, int compressionMode=boost::iostreams::zlib::best_compression)
 Build a ZipSyncFileWriter. More...
 
void finish () override
 ZipSyncFileWriter finishes the binary output archive instead of calling its parent finish method. This is necessary to prevent malfunctions coming from interaction between output archive closing and output stream closing. More...
 
- Public Member Functions inherited from helios::filems::SimpleSyncFileWriter< WriteArgs... >
 SimpleSyncFileWriter (const std::string &path, std::ios_base::openmode om=std::ios_base::app)
 Simple synchronous file writer constructor. More...
 
- 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...
 

Protected Attributes

ZipFullWaveformWriteStrategy zfwws
 The full waveform write strategy that is wrapped by the main write strategy in a vectorial fashion ( filems::ZipSyncFileWriter::writeStrategy ) More...
 
- Protected Attributes inherited from helios::filems::ZipSyncFileWriter< vector< FullWaveform > const & >
boost::iostreams::filtering_ostream compressedOut
 Compressed output stream.
 
boost::iostreams::zlib_params zp
 ZLib compression parameters.
 
unique_ptr< boost::archive::binary_oarchive > oa
 Binary output archive.
 
- Protected Attributes inherited from helios::filems::SimpleSyncFileWriter< WriteArgs... >
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 ZipSyncFileWriter to write a vector of full waveform to a zip file.

Author
Alberto M. Esmoris Pena
Version
1.0
See also
filems::ZipSyncFileWriter
filems::ZipFullWaveformWriteStrategy
FullWaveform
filems::ZipSyncFileFullWaveformWriter

Constructor & Destructor Documentation

◆ ZipVectorialSyncFileFullWaveformWriter()

helios::filems::ZipVectorialSyncFileFullWaveformWriter::ZipVectorialSyncFileFullWaveformWriter ( const string &  path,
int  compressionMode = boost::iostreams::zlib::best_compression 
)
inlineexplicit

ZIP synchronous file full waveform vector writer constructor.

See also
filems::ZipSyncFileWriter::ZipSyncFileWriter

Member Data Documentation

◆ zfwws

ZipFullWaveformWriteStrategy helios::filems::ZipVectorialSyncFileFullWaveformWriter::zfwws
protected

The full waveform write strategy that is wrapped by the main write strategy in a vectorial fashion ( filems::ZipSyncFileWriter::writeStrategy )

See also
filems::ZipFullWaveformWriteStrategy

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