Helios++
Helios software for LiDAR simulations
helios::filems::ZipMultiSyncFileWriter< WriteArgs > Class Template Reference

Abstract child of SimpleMultiSyncFileWriter which provides support for zipped output. More...

#include <ZipMultiSyncFileWriter.h>

Inheritance diagram for helios::filems::ZipMultiSyncFileWriter< WriteArgs >:
Collaboration diagram for helios::filems::ZipMultiSyncFileWriter< WriteArgs >:

Public Member Functions

 ZipMultiSyncFileWriter (std::vector< std::string > const &path, int compressionMode=boost::iostreams::zlib::best_compression)
 Build a ZipMultiSyncFileWriter. 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::SimpleMultiSyncFileWriter< WriteArgs... >
 SimpleMultiSyncFileWriter (std::vector< std::string > const &path, std::ios_base::openmode om=std::ios_base::app)
 Simple synchronous multi-file writer constructor. More...
 
void finish () override
 SimpleMultiSyncFileWriter finish method assures that any output file stream that remains open is closed.
 
- 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

std::vector< boost::iostreams::filtering_ostream > compressedOut
 Compressed output streams.
 
std::vector< boost::iostreams::zlib_params > zp
 ZLib compression parameters for each stream.
 
std::vector< unique_ptr< boost::archive::binary_oarchive > > oa
 Binary output archive for each steam.
 
- Protected Attributes inherited from helios::filems::SimpleMultiSyncFileWriter< WriteArgs... >
std::vector< std::ofstream > ofs
 Output file streams to be used by the simple multi synchronous file writer.
 
- Protected Attributes inherited from helios::filems::MultiSyncFileWriter< WriteArgs ... >
std::vector< std::string > path
 Paths to the files to be written.
 
std::vector< std::mutex > mutex
 One mutex per file to be written (i-th mutex corresponds to i-th file)
 
std::vector< std::shared_ptr< WriteStrategy< WriteArgs ... > > > writeStrategy
 The write strategies specifying how to write data, one per file.
 

Additional Inherited Members

- Protected Member Functions inherited from helios::filems::MultiSyncFileWriter< WriteArgs ... >
 MultiSyncFileWriter ()
 Default constructor for synchronous multi-file writer. More...
 
 MultiSyncFileWriter (std::vector< std::string > const &path)
 
void write (WriteArgs ... writeArgs) override
 Synchronously write to a single file. More...
 
virtual size_t indexFromWriteArgs (WriteArgs ... writeArgs)=0
 Any concrete implementation extending MultiSyncFileWriter must override this function to specify how to obtain the index from the WriteArgs. More...
 
std::string getPath (size_t const idx) const override
 Obtain the path to the idx-th file. More...
 

Detailed Description

template<typename ... WriteArgs>
class helios::filems::ZipMultiSyncFileWriter< WriteArgs >

Abstract child of SimpleMultiSyncFileWriter which provides support for zipped output.

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

Constructor & Destructor Documentation

◆ ZipMultiSyncFileWriter()

template<typename ... WriteArgs>
helios::filems::ZipMultiSyncFileWriter< WriteArgs >::ZipMultiSyncFileWriter ( std::vector< std::string > const &  path,
int  compressionMode = boost::iostreams::zlib::best_compression 
)
inlineexplicit

Build a ZipMultiSyncFileWriter.

Parameters
compressionModeCompression mode Use boost::iostreams::zlib::best_speed to reduce execution time at most. Use boost::iostreams::zlib::best_compression to reduce size at most.

Member Function Documentation

◆ finish()

template<typename ... WriteArgs>
void helios::filems::ZipMultiSyncFileWriter< WriteArgs >::finish ( )
inlineoverridevirtual

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.

See also
SimpleSyncFileWriter::finish

Reimplemented from helios::filems::SyncFileWriter< WriteArgs ... >.


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