VISR  0.12.0
Versatile Interactive Scene Renderer
visr::apputilities::Options Class Reference

#include <options.hpp>

Inheritance diagram for visr::apputilities::Options:
visr::apps::audio_network_streamer::Options visr::apps::baseline_renderer::Options visr::apps::baseline_renderer::Options visr::apps::matrix_convolver::Options visr::apps::pythonflowrunner::Options visr::maxmsp::matrix_convolver::Options visr::maxmsp::visr_renderer::Options

Public Types

enum  ParseResult { ParseResult::Success, ParseResult::Failure, ParseResult::Version, ParseResult::Help }
 

Public Member Functions

 Options ()
 
 ~Options ()
 
ParseResult parse (int argc, char const *const *argv, std::ostream &errMsg)
 
bool hasOption (char const *optionName) const
 
template<typename DataType >
DataType getOption (char const *optionName) const
 
template<typename DataType >
DataType getDefaultedOption (char const *optionName, DataType const &defaultValue) const
 
void printDescription (std::ostream &out)
 

Protected Member Functions

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)
 

Protected Attributes

boost::program_options::options_description mDescription
 
boost::program_options::positional_options_description mPositionalDescription
 
boost::program_options::variables_map mVariablesMap
 

Member Enumeration Documentation

Enumerator
Success 
Failure 
Version 
Help 

Constructor & Destructor Documentation

visr::apputilities::Options::Options ( )
visr::apputilities::Options::~Options ( )

Member Function Documentation

template<typename DataType >
DataType visr::apputilities::Options::getDefaultedOption ( char const *  optionName,
DataType const &  defaultValue 
) const
inline
template<typename DataType >
DataType visr::apputilities::Options::getOption ( char const *  optionName) const
inline
bool visr::apputilities::Options::hasOption ( char const *  optionName) const
Options::ParseResult visr::apputilities::Options::parse ( int  argc,
char const *const *  argv,
std::ostream &  errMsg 
)
void visr::apputilities::Options::printDescription ( std::ostream &  out)

Print the option description.

Parameters
outThe output stream to which the description is written to.
template<typename DataType >
void visr::apputilities::Options::registerOption ( char const *  optionName,
char const *  description 
)
inlineprotected
template<>
void visr::apputilities::Options::registerOption ( char const *  optionName,
char const *  description 
)
inlineprotected
template<typename DataType >
void visr::apputilities::Options::registerPositionalOption ( char const *  optionName,
int  position,
char const *  description 
)
inlineprotected

Member Data Documentation

boost::program_options::options_description visr::apputilities::Options::mDescription
protected
boost::program_options::positional_options_description visr::apputilities::Options::mPositionalDescription
protected
boost::program_options::variables_map visr::apputilities::Options::mVariablesMap
protected

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