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

Alberto M. Esmoris Pena. More...

#include <HeliosWriter.h>

Collaboration diagram for helios::filems::HeliosWriter< WriteArgs >:

Public Member Functions

 HeliosWriter ()=default
 Default constructor for HELIOS++ writer.
 
virtual void finish ()
 Finish the sync file writer. More...
 
virtual bool hasWriter () const
 Check whether the HeliosWriter has a non null writer (true) or not (false) More...
 
virtual fs::path getOutputFilePath () const
 Get the path to the output file. More...
 
virtual string getOutputPath () const
 
bool isLasOutput () const
 Get the LAS output flag. More...
 
void setLasOutput (bool const lasOutput)
 Set the LAS output flag. More...
 
bool isLas10 () const
 Get the LAS 10 specification flag. More...
 
void setLas10 (bool const las10)
 Set the LAS output flag. More...
 
bool isZipOutput () const
 Get the zip output flag. More...
 
void setZipOutput (bool const zipOutput)
 Set the zip output flag. More...
 
double getLasScale () const
 Obtain the LAS scale of the measurement writer. More...
 
void setLasScale (double const lasScale)
 Set the LAS scale of the measurement writer. More...
 

Protected Attributes

shared_ptr< SyncFileWriter< WriteArgs ... > > sfw = nullptr
 Synchronous file writer. More...
 
bool lasOutput = false
 Flag specifying if detector output must be written in LAS format (true) or not (false) More...
 
bool las10 = false
 Flag specifying if detect output must be writing in LAS 1.0 (LAS 1.4 is written by default)
 
bool zipOutput = false
 Flag specifying if detector output must be zipped (true) or not (false)
 
double lasScale = 0.0001
 Scale factor specification to be used when LAS output format specified. More...
 

Detailed Description

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

Alberto M. Esmoris Pena.

Version
1.0

Base class providing the core for writers of different HELIOS++ outputs (measurements, trajectory, full waveform)

Member Function Documentation

◆ finish()

◆ getLasScale()

template<typename ... WriteArgs>
double helios::filems::HeliosWriter< WriteArgs >::getLasScale ( ) const
inline

Obtain the LAS scale of the measurement writer.

See also
filems::HeliosWriter::lasScale

◆ getOutputFilePath()

template<typename ... WriteArgs>
virtual fs::path helios::filems::HeliosWriter< WriteArgs >::getOutputFilePath ( ) const
inlinevirtual

◆ getOutputPath()

◆ hasWriter()

template<typename ... WriteArgs>
virtual bool helios::filems::HeliosWriter< WriteArgs >::hasWriter ( ) const
inlinevirtual

Check whether the HeliosWriter has a non null writer (true) or not (false)

Returns
True if the HeliosWriter has a non null writer, false otherwise

◆ isLas10()

template<typename ... WriteArgs>
bool helios::filems::HeliosWriter< WriteArgs >::isLas10 ( ) const
inline

Get the LAS 10 specification flag.

See also
filems::HeliosWriter::las10

◆ isLasOutput()

template<typename ... WriteArgs>
bool helios::filems::HeliosWriter< WriteArgs >::isLasOutput ( ) const
inline

Get the LAS output flag.

See also
filems::HeliosWriter::lasOutput

◆ isZipOutput()

template<typename ... WriteArgs>
bool helios::filems::HeliosWriter< WriteArgs >::isZipOutput ( ) const
inline

Get the zip output flag.

See also
filems::HeliosWriter::zipOutput

◆ setLas10()

template<typename ... WriteArgs>
void helios::filems::HeliosWriter< WriteArgs >::setLas10 ( bool const  las10)
inline

Set the LAS output flag.

See also
filems::HeliosWriter::las10

◆ setLasOutput()

template<typename ... WriteArgs>
void helios::filems::HeliosWriter< WriteArgs >::setLasOutput ( bool const  lasOutput)
inline

Set the LAS output flag.

See also
filems::HeliosWriter::lasOutput

◆ setLasScale()

template<typename ... WriteArgs>
void helios::filems::HeliosWriter< WriteArgs >::setLasScale ( double const  lasScale)
inline

Set the LAS scale of the measurement writer.

See also
filems::HeliosWriter::lasScale

◆ setZipOutput()

template<typename ... WriteArgs>
void helios::filems::HeliosWriter< WriteArgs >::setZipOutput ( bool const  zipOutput)
inline

Set the zip output flag.

See also
filems::HeliosWriter::zipOutput

Member Data Documentation

◆ lasOutput

template<typename ... WriteArgs>
bool helios::filems::HeliosWriter< WriteArgs >::lasOutput = false
protected

Flag specifying if detector output must be written in LAS format (true) or not (false)

See also
helios::filems::HeliosWriter::lasScale

◆ lasScale

template<typename ... WriteArgs>
double helios::filems::HeliosWriter< WriteArgs >::lasScale = 0.0001
protected

Scale factor specification to be used when LAS output format specified.

See also
helios::filems::HeliosWriter::lasOutput

◆ sfw

template<typename ... WriteArgs>
shared_ptr<SyncFileWriter<WriteArgs ...> > helios::filems::HeliosWriter< WriteArgs >::sfw = nullptr
protected

Synchronous file writer.

See also
filems::SyncFileWriter

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