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

Class to handle writing of trajectories to generate HELIOS++ output virtual trajectories. More...

#include <TrajectoryWriter.h>

Inheritance diagram for helios::filems::TrajectoryWriter:
Collaboration diagram for helios::filems::TrajectoryWriter:

Public Member Functions

 TrajectoryWriter ()=default
 Default constructor for trajectory writer.
 
void configure (string const &parent, string const &prefix)
 Configure the output path for the trajectory writer. More...
 
void writeTrajectory (Trajectory const &t)
 Write a trajectory point. More...
 
void writeTrajectoryUnsafe (Trajectory const &t) const
 Like filems::TrajectoryWriter::writeTrajectory but faster because there is no validation. More...
 
void setSyncFileWriter (shared_ptr< SyncFileWriter< Trajectory const & >> sfw)
 Set synchronous file writer for trajectory writer. More...
 
shared_ptr< SyncFileWriter< Trajectory const & > > getSyncFileWriter () const
 Get the synchronous file writer used to write trajectories. More...
 
void setOutputFilePath (string const &path)
 Set path to output file. More...
 
fs::path getOutputFilePath () const
 Get the path to the output file. More...
 
string getOutputPath () const
 
- Public Member Functions inherited from helios::filems::HeliosWriter< Trajectory const & >
 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...
 
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...
 

Additional Inherited Members

- Protected Attributes inherited from helios::filems::HeliosWriter< Trajectory const & >
shared_ptr< SyncFileWriter< WriteArgs ... > > sfw
 Synchronous file writer. More...
 
bool lasOutput
 Flag specifying if detector output must be written in LAS format (true) or not (false) More...
 
bool las10
 Flag specifying if detect output must be writing in LAS 1.0 (LAS 1.4 is written by default)
 
bool zipOutput
 Flag specifying if detector output must be zipped (true) or not (false)
 
double lasScale
 Scale factor specification to be used when LAS output format specified. More...
 

Detailed Description

Class to handle writing of trajectories to generate HELIOS++ output virtual trajectories.

Author
Alberto M. Esmoris Pena
Version
1.0

Member Function Documentation

◆ configure()

void TrajectoryWriter::configure ( string const &  parent,
string const &  prefix 
)

Configure the output path for the trajectory writer.

Parameters
parentPath to output directory for trajectory files
prefixPrefix for the name of the output file

◆ getOutputFilePath()

fs::path helios::filems::TrajectoryWriter::getOutputFilePath ( ) const
inlinevirtual

Get the path to the output file.

Returns
The path to the output file
See also
filems::TrajectoryWriter::getOutputPath

Reimplemented from helios::filems::HeliosWriter< Trajectory const & >.

◆ getOutputPath()

string helios::filems::TrajectoryWriter::getOutputPath ( ) const
inlinevirtual

◆ getSyncFileWriter()

shared_ptr<SyncFileWriter<Trajectory const&> > helios::filems::TrajectoryWriter::getSyncFileWriter ( ) const
inline

Get the synchronous file writer used to write trajectories.

See also
filems::TrajectoryWriter::sfw

◆ setOutputFilePath()

void TrajectoryWriter::setOutputFilePath ( string const &  path)

Set path to output file.

Parameters
pathNew path to output file

◆ setSyncFileWriter()

void helios::filems::TrajectoryWriter::setSyncFileWriter ( shared_ptr< SyncFileWriter< Trajectory const & >>  sfw)
inline

Set synchronous file writer for trajectory writer.

Parameters
sfwSynchronous file writer to be used to write trajectory
See also
filems::TrajectoryWriter::sfw

◆ writeTrajectory()

void TrajectoryWriter::writeTrajectory ( Trajectory const &  t)

Write a trajectory point.

Parameters
tTrajectory point to be written

◆ writeTrajectoryUnsafe()

void helios::filems::TrajectoryWriter::writeTrajectoryUnsafe ( Trajectory const &  t) const
inline

Like filems::TrajectoryWriter::writeTrajectory but faster because there is no validation.

See also
filems::TrajectoryWriter::writeTrajectory

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