Helios++
Helios software for LiDAR simulations
helios::filems::SyncFileWriter< WriteArgs > Class Template Referenceabstract

Abstract class defining common behavior for all synchronous file writers. More...

#include <SyncFileWriter.h>

Public Member Functions

 SyncFileWriter ()=default
 Default constructor for synchronous file writer.
 
virtual void write (WriteArgs ... writeArgs)=0
 Handle synchronous write operations.
 
virtual void finish ()
 Finish the writing so all writing operations are performed and all buffers are closed.
 
virtual std::string getPath (size_t const idx) const =0
 Obtain the path to the file corresponding to the idx-th writing stream. More...
 
std::string getPath ()
 Non index version of the SyncFileWriter::getPath(size_t const) function. More...
 

Detailed Description

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

Abstract class defining common behavior for all synchronous file writers.

Author
Alberto M. Esmoris Pena
Version
1.0
Template Parameters
WriteArgsArguments for the write operation

Member Function Documentation

◆ getPath() [1/2]

template<typename ... WriteArgs>
std::string helios::filems::SyncFileWriter< WriteArgs >::getPath ( )
inline

Non index version of the SyncFileWriter::getPath(size_t const) function.

See also
SyncFileWriter::getPath(size_t const)

◆ getPath() [2/2]

template<typename ... WriteArgs>
virtual std::string helios::filems::SyncFileWriter< WriteArgs >::getPath ( size_t const  idx) const
pure virtual

Obtain the path to the file corresponding to the idx-th writing stream.

Parameters
idxThe index of the writing stream which path must be obtained
Returns
Path to the file corresponding to the idx-th writing stream

Implemented in helios::filems::SingleSyncFileWriter< WriteArgs >, helios::filems::SingleSyncFileWriter< WriteArgs ... >, helios::filems::MultiSyncFileWriter< WriteArgs >, and helios::filems::MultiSyncFileWriter< WriteArgs ... >.


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