#include <options.hpp>
|
template<typename DataType > |
void | registerOption (char const *optionName, char const *description) |
|
template<typename DataType > |
void | registerPositionalOption (char const *optionName, int position, char const *description) |
|
template<> |
void | registerOption (char const *optionName, char const *description) |
|
◆ ParseResult
Enumerator |
---|
Success | |
Failure | |
Version | |
Help | |
◆ Options()
visr::apputilities::Options::Options |
( |
| ) |
|
◆ ~Options()
visr::apputilities::Options::~Options |
( |
| ) |
|
◆ getDefaultedOption()
template<typename DataType >
DataType visr::apputilities::Options::getDefaultedOption |
( |
char const * |
optionName, |
|
|
DataType const & |
defaultValue |
|
) |
| const |
|
inline |
◆ getOption()
template<typename DataType >
DataType visr::apputilities::Options::getOption |
( |
char const * |
optionName | ) |
const |
|
inline |
◆ hasOption()
bool visr::apputilities::Options::hasOption |
( |
char const * |
optionName | ) |
const |
◆ parse()
Options::ParseResult visr::apputilities::Options::parse |
( |
int |
argc, |
|
|
char const *const * |
argv, |
|
|
std::ostream & |
errMsg |
|
) |
| |
◆ printDescription()
void visr::apputilities::Options::printDescription |
( |
std::ostream & |
out | ) |
|
Print the option description.
- Parameters
-
out | The output stream to which the description is written to. |
◆ registerOption() [1/2]
template<typename DataType >
void visr::apputilities::Options::registerOption |
( |
char const * |
optionName, |
|
|
char const * |
description |
|
) |
| |
|
inlineprotected |
◆ registerOption() [2/2]
template<>
void visr::apputilities::Options::registerOption |
( |
char const * |
optionName, |
|
|
char const * |
description |
|
) |
| |
|
inlineprotected |
◆ registerPositionalOption()
template<typename DataType >
void visr::apputilities::Options::registerPositionalOption |
( |
char const * |
optionName, |
|
|
int |
position, |
|
|
char const * |
description |
|
) |
| |
|
inlineprotected |
◆ mDescription
boost::program_options::options_description visr::apputilities::Options::mDescription |
|
protected |
◆ mPositionalDescription
boost::program_options::positional_options_description visr::apputilities::Options::mPositionalDescription |
|
protected |
◆ mVariablesMap
boost::program_options::variables_map visr::apputilities::Options::mVariablesMap |
|
protected |
The documentation for this class was generated from the following files:
- /var/lib/gitlab-runner/builds/a23a46af/0/s3a/VISR/src/libapputilities/options.hpp
- /var/lib/gitlab-runner/builds/a23a46af/0/s3a/VISR/src/libapputilities/options.cpp