Public Member Functions | Private Attributes | List of all members
ascii_convert::Options Class Reference

A class to parse the program options for the reconstruction executable. More...

#include <Options.hpp>

Public Member Functions

int b ()
 Returns the position of the x coordinate in the data. More...
 
bool convertRemission () const
 If true, intinesites will be converted to colors. More...
 
int g ()
 Returns the position of the x coordinate in the data. More...
 
int i ()
 Returns the position of the x coordinate in the data. More...
 
string inputFile () const
 Retuns the input file. More...
 
 Options (int argc, char **argv)
 Ctor. Parses the command parameters given to the main function of the program. More...
 
string outputFile () const
 Retuns the input file. More...
 
bool printUsage () const
 Prints a usage message. More...
 
int r ()
 Returns the position of the x coordinate in the data. More...
 
float sx ()
 Returns the scaling factor for the x coordinates. More...
 
float sy ()
 Returns the scaling factor for the y coordinates. More...
 
float sz ()
 Returns the scaling factor for the z coordinates. More...
 
int x ()
 Returns the position of the x coordinate in the data. More...
 
int y ()
 Returns the position of the x coordinate in the data. More...
 
int z ()
 Returns the position of the x coordinate in the data. More...
 
virtual ~Options ()
 

Private Attributes

options_description m_descr
 The internally used option description. More...
 
string m_outputFile
 Output file name. More...
 
positional_options_description m_pdescr
 The internally used positional option desription. More...
 
variables_map m_variables
 The internally used variable map. More...
 

Detailed Description

A class to parse the program options for the reconstruction executable.

Definition at line 59 of file src/tools/lvr2_asciiconverter/Options.hpp.

Constructor & Destructor Documentation

◆ Options()

Options::Options ( int  argc,
char **  argv 
)

Ctor. Parses the command parameters given to the main function of the program.

Definition at line 40 of file src/tools/lvr2_asciiconverter/Options.cpp.

◆ ~Options()

Options::~Options ( )
virtual

Definition at line 110 of file src/tools/lvr2_asciiconverter/Options.cpp.

Member Function Documentation

◆ b()

int ascii_convert::Options::b ( )
inline

Returns the position of the x coordinate in the data.

Definition at line 97 of file src/tools/lvr2_asciiconverter/Options.hpp.

◆ convertRemission()

bool Options::convertRemission ( ) const

If true, intinesites will be converted to colors.

Definition at line 76 of file src/tools/lvr2_asciiconverter/Options.cpp.

◆ g()

int ascii_convert::Options::g ( )
inline

Returns the position of the x coordinate in the data.

Definition at line 92 of file src/tools/lvr2_asciiconverter/Options.hpp.

◆ i()

int ascii_convert::Options::i ( )
inline

Returns the position of the x coordinate in the data.

Definition at line 102 of file src/tools/lvr2_asciiconverter/Options.hpp.

◆ inputFile()

string Options::inputFile ( ) const

Retuns the input file.

Definition at line 81 of file src/tools/lvr2_asciiconverter/Options.cpp.

◆ outputFile()

string Options::outputFile ( ) const

Retuns the input file.

Definition at line 86 of file src/tools/lvr2_asciiconverter/Options.cpp.

◆ printUsage()

bool Options::printUsage ( ) const

Prints a usage message.

Definition at line 91 of file src/tools/lvr2_asciiconverter/Options.cpp.

◆ r()

int ascii_convert::Options::r ( )
inline

Returns the position of the x coordinate in the data.

Definition at line 87 of file src/tools/lvr2_asciiconverter/Options.hpp.

◆ sx()

float ascii_convert::Options::sx ( )
inline

Returns the scaling factor for the x coordinates.

Definition at line 108 of file src/tools/lvr2_asciiconverter/Options.hpp.

◆ sy()

float ascii_convert::Options::sy ( )
inline

Returns the scaling factor for the y coordinates.

Definition at line 113 of file src/tools/lvr2_asciiconverter/Options.hpp.

◆ sz()

float ascii_convert::Options::sz ( )
inline

Returns the scaling factor for the z coordinates.

Definition at line 118 of file src/tools/lvr2_asciiconverter/Options.hpp.

◆ x()

int ascii_convert::Options::x ( )
inline

Returns the position of the x coordinate in the data.

Definition at line 72 of file src/tools/lvr2_asciiconverter/Options.hpp.

◆ y()

int ascii_convert::Options::y ( )
inline

Returns the position of the x coordinate in the data.

Definition at line 77 of file src/tools/lvr2_asciiconverter/Options.hpp.

◆ z()

int ascii_convert::Options::z ( )
inline

Returns the position of the x coordinate in the data.

Definition at line 82 of file src/tools/lvr2_asciiconverter/Options.hpp.

Member Data Documentation

◆ m_descr

options_description ascii_convert::Options::m_descr
private

The internally used option description.

Definition at line 150 of file src/tools/lvr2_asciiconverter/Options.hpp.

◆ m_outputFile

string ascii_convert::Options::m_outputFile
private

Output file name.

Definition at line 144 of file src/tools/lvr2_asciiconverter/Options.hpp.

◆ m_pdescr

positional_options_description ascii_convert::Options::m_pdescr
private

The internally used positional option desription.

Definition at line 153 of file src/tools/lvr2_asciiconverter/Options.hpp.

◆ m_variables

variables_map ascii_convert::Options::m_variables
private

The internally used variable map.

Definition at line 147 of file src/tools/lvr2_asciiconverter/Options.hpp.


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


lvr2
Author(s): Thomas Wiemann , Sebastian Pütz , Alexander Mock , Lars Kiesow , Lukas Kalbertodt , Tristan Igelbrink , Johan M. von Behren , Dominik Feldschnieders , Alexander Löhr
autogenerated on Mon Feb 28 2022 22:46:11