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

Concrete class specializing a SimpleMultiSyncFileWriter to write vectors of measurements directly to files with support for concurrent multiple output streams. More...

#include <SimpleMultiVectorialSyncFileMeasurementWriter.h>

Inheritance diagram for helios::filems::SimpleMultiVectorialSyncFileMeasurementWriter:
Collaboration diagram for helios::filems::SimpleMultiVectorialSyncFileMeasurementWriter:

Public Member Functions

 SimpleMultiVectorialSyncFileMeasurementWriter (vector< string > const &path, std::ios_base::openmode om=std::ios_base::app)
 Simple synchronous file measurement vector multi-writer constructor. More...
 
void buildMeasurementWriteStrategies ()
 Build the measurement write strategies for the simple multi vectorial synchronous file measurement writer.
 
void buildVectorialWriteStrategies ()
 Build the vectorial write strategies for the simple multi vectorial synchronous file measurement writer. More...
 
size_t indexFromWriteArgs (vector< Measurement > const &measurements, glm::dvec3 const &offset) override
 
- Public Member Functions inherited from helios::filems::SimpleMultiSyncFileWriter< vector< Measurement > const &, glm::dvec3 const & >
 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

vector< DirectMeasurementWriteStrategydmws
 The measurement write strategies that are wrapped by the main write strategies in a vectorial fashion ( filems::SimpleMultiSyncFileWriter::writeStrategy )
 
- Protected Attributes inherited from helios::filems::SimpleMultiSyncFileWriter< vector< Measurement > const &, glm::dvec3 const & >
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

Concrete class specializing a SimpleMultiSyncFileWriter to write vectors of measurements directly to files with support for concurrent multiple output streams.

Author
Alberto M. Esmoris PEna
Version
1.0

Constructor & Destructor Documentation

◆ SimpleMultiVectorialSyncFileMeasurementWriter()

helios::filems::SimpleMultiVectorialSyncFileMeasurementWriter::SimpleMultiVectorialSyncFileMeasurementWriter ( vector< string > const &  path,
std::ios_base::openmode  om = std::ios_base::app 
)
inlineexplicit

Simple synchronous file measurement vector multi-writer constructor.

See also
filems::SimpleMultiSyncFileWriter::SimpleMultiSyncFileWriter

Member Function Documentation

◆ buildVectorialWriteStrategies()

void helios::filems::SimpleMultiVectorialSyncFileMeasurementWriter::buildVectorialWriteStrategies ( )
inline

Build the vectorial write strategies for the simple multi vectorial synchronous file measurement writer.

WARNING! calling the buildMeasurementWriteStrategies() method will invalidate the state generated by buildVectorialWriteStrategies()

◆ indexFromWriteArgs()

size_t helios::filems::SimpleMultiVectorialSyncFileMeasurementWriter::indexFromWriteArgs ( vector< Measurement > const &  measurements,
glm::dvec3 const &  offset 
)
inlineoverride

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