chunking::Options Class Reference

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

#include <Options.hpp>

Public Member Functions
int	getCacheSize () const
	Returns the cacheSize (maximum number of chunks in HashMap while loading) More...
string	getChunkedMesh () const
	Returns the chunked mesh file. More...
float	getChunkSize () const
	Returns the side length of a chunk. More...
std::vector< std::string >	getInputFile () const
	Returns the input file. More...
bool	getLoad () const
	Returns the load-flag. set to true for loading an existing hdf5-file and to false for chunking and saving a given mesh. More...
float	getMaxChunkOverlap () const
	Returns the maximum allowed chunk overlap. More...
std::string	getMeshGroup () const
	Returns the mesh group in the HDF5. More...
string	getOutputDir () const
	Returns the output directory. More...
float	getXMax () const
	Returns the x-max of the bounding box. More...
float	getXMin () const
	Returns the x-min of the bounding box. More...
float	getYMax () const
	Returns the y-max of the bounding box. More...
float	getYMin () const
	Returns the y-min of the bounding box. More...
float	getZMax () const
	Returns the z-max of the bounding box. More...
float	getZMin () const
	Returns the z-min of the bounding box. 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_posDescr
	The internally used positional option description. More...
variables_map	m_variables
	The internally used variable map. More...

Detailed Description

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

Definition at line 54 of file src/tools/lvr2_chunking/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 47 of file src/tools/lvr2_chunking/Options.cpp.

~Options()

Options::~Options ( )

virtual

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

Member Function Documentation

getCacheSize()

int Options::getCacheSize

(

)

const

Returns the cacheSize (maximum number of chunks in HashMap while loading)

Definition at line 153 of file src/tools/lvr2_chunking/Options.cpp.

getChunkedMesh()

string Options::getChunkedMesh

(

)

const

Returns the chunked mesh file.

Definition at line 120 of file src/tools/lvr2_chunking/Options.cpp.

getChunkSize()

float Options::getChunkSize

(

)

const

Returns the side length of a chunk.

Definition at line 111 of file src/tools/lvr2_chunking/Options.cpp.

getInputFile()

std::vector< string > Options::getInputFile

(

)

const

Returns the input file.

Definition at line 100 of file src/tools/lvr2_chunking/Options.cpp.

getLoad()

bool Options::getLoad

(

)

const

Returns the load-flag. set to true for loading an existing hdf5-file and to false for chunking and saving a given mesh.

Definition at line 124 of file src/tools/lvr2_chunking/Options.cpp.

getMaxChunkOverlap()

float Options::getMaxChunkOverlap

(

)

const

Returns the maximum allowed chunk overlap.

Definition at line 116 of file src/tools/lvr2_chunking/Options.cpp.

getMeshGroup()

std::string Options::getMeshGroup

(

)

const

Returns the mesh group in the HDF5.

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

getOutputDir()

string Options::getOutputDir

(

)

const

Returns the output directory.

Definition at line 106 of file src/tools/lvr2_chunking/Options.cpp.

getXMax()

float Options::getXMax

(

)

const

Returns the x-max of the bounding box.

Definition at line 141 of file src/tools/lvr2_chunking/Options.cpp.

getXMin()

float Options::getXMin

(

)

const

Returns the x-min of the bounding box.

Definition at line 129 of file src/tools/lvr2_chunking/Options.cpp.

getYMax()

float Options::getYMax

(

)

const

Returns the y-max of the bounding box.

Definition at line 145 of file src/tools/lvr2_chunking/Options.cpp.

getYMin()

float Options::getYMin

(

)

const

Returns the y-min of the bounding box.

Definition at line 133 of file src/tools/lvr2_chunking/Options.cpp.

getZMax()

float Options::getZMax

(

)

const

Returns the z-max of the bounding box.

Definition at line 149 of file src/tools/lvr2_chunking/Options.cpp.

getZMin()

float Options::getZMin

(

)

const

Returns the z-min of the bounding box.

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

printUsage()

bool Options::printUsage

(

)

const

Prints a usage message to stdout.

Definition at line 73 of file src/tools/lvr2_chunking/Options.cpp.

Member Data Documentation

m_descr

options_description chunking::Options::m_descr

private

The internally used option description.

Definition at line 137 of file src/tools/lvr2_chunking/Options.hpp.

m_posDescr

positional_options_description chunking::Options::m_posDescr

private

The internally used positional option description.

Definition at line 140 of file src/tools/lvr2_chunking/Options.hpp.

m_variables

variables_map chunking::Options::m_variables

private

The internally used variable map.

Definition at line 134 of file src/tools/lvr2_chunking/Options.hpp.

---

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

• src/tools/lvr2_chunking/Options.hpp
• src/tools/lvr2_chunking/Options.cpp