toolbox::util::Options Class Reference

#include <toolbox/util/Options.hpp>

Public Member Functions
	Options (std::string description="")
template<typename DataT >
Options &	operator() (const std::string &long_opt, DataT &&option_data, std::string description="")
template<typename DataT >
Options &	operator() (char short_opt, const std::string &long_opt, DataT &&data, std::string description="")
template<typename DataT >
Options &	operator() (DataT data, std::string="")
template<typename DataT >
Options &	operator() (char short_opt, DataT &&option_data, std::string description="")
bool	operator[] (const std::string &long_opt) const noexcept
bool	operator[] (char short_opt) const noexcept
void	parse (int argc, const char *const argv[])

Friends
template<typename StreamT > requires Streamable<StreamT>
StreamT &	operator<< (StreamT &out, const Options &options)

Detailed Description

Definition at line 121 of file Options.hpp.

Constructor & Destructor Documentation

Options()

toolbox::util::Options::Options ( std::string  description = "" )

explicit

Definition at line 28 of file Options.cpp.

Member Function Documentation

operator()() [1/4]

template<typename DataT >

Options & toolbox::util::Options::operator() ( const std::string &  long_opt, DataT &&  option_data, std::string  description = ""  )

inline

Definition at line 165 of file Options.hpp.

operator()() [2/4]

template<typename DataT >

Options & toolbox::util::Options::operator() ( char  short_opt, const std::string &  long_opt, DataT &&  data, std::string  description = ""  )

inline

Definition at line 173 of file Options.hpp.

operator()() [3/4]

template<typename DataT >

Options & toolbox::util::Options::operator() ( DataT  data, std::string  = ""  )

inline

Definition at line 196 of file Options.hpp.

operator()() [4/4]

template<typename DataT >

Options & toolbox::util::Options::operator() ( char  short_opt, DataT &&  option_data, std::string  description = ""  )

inline

Definition at line 203 of file Options.hpp.

operator[]() [1/2]

bool toolbox::util::Options::operator[] ( const std::string &  long_opt ) const

noexcept

Definition at line 33 of file Options.cpp.

operator[]() [2/2]

bool toolbox::util::Options::operator[] ( char  short_opt ) const

noexcept

Definition at line 38 of file Options.cpp.

parse()

void toolbox::util::Options::parse	(	int	argc,
		const char *const	argv[]
	)

Definition at line 43 of file Options.cpp.

Friends And Related Symbol Documentation

operator<<

template<typename StreamT >
requires Streamable<StreamT>

StreamT & operator<< ( StreamT &  out, const Options &  options  )

friend

Definition at line 229 of file Options.hpp.

---

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

• toolbox/util/Options.hpp
• toolbox/util/Options.cpp