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

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

#include <Options.hpp>

Public Member Functions

bool anyRotation () const
 Returns true if there is any rotation value. More...
 
bool anyRotationX () const
 Returns true if there is any x-rotation value. More...
 
bool anyRotationY () const
 Returns true if there is any y-rotation value. More...
 
bool anyRotationZ () const
 Returns true if there is any z-rotation value. More...
 
bool anyScale () const
 Returns true if there is any scale value. More...
 
bool anyScaleX () const
 Returns true if there is any x-scale value. More...
 
bool anyScaleY () const
 Returns true if there is any y-scale value. More...
 
bool anyScaleZ () const
 Returns true if there is any z-scale value. More...
 
bool anyTransformFile () const
 Returns true if transform file is given. More...
 
bool anyTranslation () const
 Returns true if there is any translation value. More...
 
bool anyTranslationX () const
 Returns true if there is any x translation value. More...
 
bool anyTranslationY () const
 Returns true if there is any y translation value. More...
 
bool anyTranslationZ () const
 Returns true if there is any z translation value. More...
 
string getInputFile () const
 Returns the output file name. More...
 
string getOutputFile () const
 Returns the output file name. More...
 
float getRotationX () const
 Returns the x axis rotation. More...
 
float getRotationY () const
 Returns the y axis rotation. More...
 
float getRotationZ () const
 Returns the z axis rotation. More...
 
float getScaleX () const
 Returns the x axis scale. More...
 
float getScaleY () const
 Returns the y axis scale. More...
 
float getScaleZ () const
 Returns the z axis scale. More...
 
string getTransformFile () const
 Returns the transform file name. More...
 
float getTranslationX () const
 Returns the x axis translation. More...
 
float getTranslationY () const
 Returns the y axis translation. More...
 
float getTranslationZ () const
 Returns the z axis translation. More...
 
 Options (int argc, char **argv)
 Ctor. Parses the command parameters given to the main function of the program. More...
 
bool printUsage () const
 Prints a usage message to stdout. More...
 
virtual ~Options ()
 

Private Attributes

options_description m_descr
 The internally used option description. 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 60 of file src/tools/lvr2_transform/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 46 of file src/tools/lvr2_transform/Options.cpp.

◆ ~Options()

Options::~Options ( )
virtual

Definition at line 244 of file src/tools/lvr2_transform/Options.cpp.

Member Function Documentation

◆ anyRotation()

bool Options::anyRotation ( ) const

Returns true if there is any rotation value.

Definition at line 167 of file src/tools/lvr2_transform/Options.cpp.

◆ anyRotationX()

bool Options::anyRotationX ( ) const

Returns true if there is any x-rotation value.

Definition at line 172 of file src/tools/lvr2_transform/Options.cpp.

◆ anyRotationY()

bool Options::anyRotationY ( ) const

Returns true if there is any y-rotation value.

Definition at line 177 of file src/tools/lvr2_transform/Options.cpp.

◆ anyRotationZ()

bool Options::anyRotationZ ( ) const

Returns true if there is any z-rotation value.

Definition at line 182 of file src/tools/lvr2_transform/Options.cpp.

◆ anyScale()

bool Options::anyScale ( ) const

Returns true if there is any scale value.

Definition at line 147 of file src/tools/lvr2_transform/Options.cpp.

◆ anyScaleX()

bool Options::anyScaleX ( ) const

Returns true if there is any x-scale value.

Definition at line 152 of file src/tools/lvr2_transform/Options.cpp.

◆ anyScaleY()

bool Options::anyScaleY ( ) const

Returns true if there is any y-scale value.

Definition at line 157 of file src/tools/lvr2_transform/Options.cpp.

◆ anyScaleZ()

bool Options::anyScaleZ ( ) const

Returns true if there is any z-scale value.

Definition at line 162 of file src/tools/lvr2_transform/Options.cpp.

◆ anyTransformFile()

bool Options::anyTransformFile ( ) const

Returns true if transform file is given.

Definition at line 97 of file src/tools/lvr2_transform/Options.cpp.

◆ anyTranslation()

bool Options::anyTranslation ( ) const

Returns true if there is any translation value.

Definition at line 187 of file src/tools/lvr2_transform/Options.cpp.

◆ anyTranslationX()

bool Options::anyTranslationX ( ) const

Returns true if there is any x translation value.

Definition at line 192 of file src/tools/lvr2_transform/Options.cpp.

◆ anyTranslationY()

bool Options::anyTranslationY ( ) const

Returns true if there is any y translation value.

Definition at line 197 of file src/tools/lvr2_transform/Options.cpp.

◆ anyTranslationZ()

bool Options::anyTranslationZ ( ) const

Returns true if there is any z translation value.

Definition at line 202 of file src/tools/lvr2_transform/Options.cpp.

◆ getInputFile()

string Options::getInputFile ( ) const

Returns the output file name.

Definition at line 82 of file src/tools/lvr2_transform/Options.cpp.

◆ getOutputFile()

string Options::getOutputFile ( ) const

Returns the output file name.

Definition at line 87 of file src/tools/lvr2_transform/Options.cpp.

◆ getRotationX()

float Options::getRotationX ( ) const

Returns the x axis rotation.

Definition at line 117 of file src/tools/lvr2_transform/Options.cpp.

◆ getRotationY()

float Options::getRotationY ( ) const

Returns the y axis rotation.

Definition at line 122 of file src/tools/lvr2_transform/Options.cpp.

◆ getRotationZ()

float Options::getRotationZ ( ) const

Returns the z axis rotation.

Definition at line 127 of file src/tools/lvr2_transform/Options.cpp.

◆ getScaleX()

float Options::getScaleX ( ) const

Returns the x axis scale.

Definition at line 102 of file src/tools/lvr2_transform/Options.cpp.

◆ getScaleY()

float Options::getScaleY ( ) const

Returns the y axis scale.

Definition at line 107 of file src/tools/lvr2_transform/Options.cpp.

◆ getScaleZ()

float Options::getScaleZ ( ) const

Returns the z axis scale.

Definition at line 112 of file src/tools/lvr2_transform/Options.cpp.

◆ getTransformFile()

string Options::getTransformFile ( ) const

Returns the transform file name.

Definition at line 92 of file src/tools/lvr2_transform/Options.cpp.

◆ getTranslationX()

float Options::getTranslationX ( ) const

Returns the x axis translation.

Definition at line 132 of file src/tools/lvr2_transform/Options.cpp.

◆ getTranslationY()

float Options::getTranslationY ( ) const

Returns the y axis translation.

Definition at line 137 of file src/tools/lvr2_transform/Options.cpp.

◆ getTranslationZ()

float Options::getTranslationZ ( ) const

Returns the z axis translation.

Definition at line 142 of file src/tools/lvr2_transform/Options.cpp.

◆ printUsage()

bool Options::printUsage ( ) const

Prints a usage message to stdout.

Definition at line 207 of file src/tools/lvr2_transform/Options.cpp.

Member Data Documentation

◆ m_descr

options_description transform::Options::m_descr
private

The internally used option description.

Definition at line 206 of file src/tools/lvr2_transform/Options.hpp.

◆ m_pdescr

positional_options_description transform::Options::m_pdescr
private

The internally used positional option desription.

Definition at line 209 of file src/tools/lvr2_transform/Options.hpp.

◆ m_variables

variables_map transform::Options::m_variables
private

The internally used variable map.

Definition at line 203 of file src/tools/lvr2_transform/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 Wed Mar 2 2022 00:37:28