Class cxxopts::Options

ClassList > cxxopts > Options

Public Functions

Type	Name
	Options (std::string program_name, std::string help_string="")
	Options (std::string program_name, std::string help_string="")
void	add_option (const std::string & group, const Option & option)
void	add_option (const std::string & group, const std::string & s, const OptionNames & l, std::string desc, const std::shared_ptr< const Value > & value, std::string arg_help)
void	add_option (const std::string & group, const std::string & short_name, const std::string & single_long_name, std::string desc, const std::shared_ptr< const Value > & value, std::string arg_help)
void	add_option (const std::string & group, const Option & option)
void	add_option (const std::string & group, const std::string & s, const OptionNames & l, std::string desc, const std::shared_ptr< const Value > & value, std::string arg_help)
void	add_option (const std::string & group, const std::string & short_name, const std::string & single_long_name, std::string desc, const std::shared_ptr< const Value > & value, std::string arg_help)
OptionAdder	add_options (std::string group="")
void	add_options (const std::string & group, std::initializer_list< Option > options)
OptionAdder	add_options (std::string group="")
void	add_options (const std::string & group, std::initializer_list< Option > options)
Options &	allow_unrecognised_options ()
Options &	allow_unrecognised_options ()
Options &	custom_help (std::string help_text)
Options &	custom_help (std::string help_text)
const HelpGroupDetails &	group_help (const std::string & group) const
const HelpGroupDetails &	group_help (const std::string & group) const
std::vector< std::string >	groups () const
std::vector< std::string >	groups () const
std::string	help (const std::vector< std::string > & groups={}, bool print_usage=true) const
std::string	help (const std::vector< std::string > & groups={}, bool print_usage=true) const
ParseResult	parse (int argc, const char *const * argv)
ParseResult	parse (int argc, const char *const * argv)
void	parse_positional (std::string option)
void	parse_positional (std::vector< std::string > options)
void	parse_positional (std::initializer_list< std::string > options)
void	parse_positional (Iterator begin, Iterator end)
void	parse_positional (std::string option)
void	parse_positional (std::vector< std::string > options)
void	parse_positional (std::initializer_list< std::string > options)
void	parse_positional (Iterator begin, Iterator end)
Options &	positional_help (std::string help_text)
Options &	positional_help (std::string help_text)
const std::string &	program () const
const std::string &	program () const
Options &	set_tab_expansion (bool expansion=true)
Options &	set_tab_expansion (bool expansion=true)
Options &	set_width (std::size_t width)
Options &	set_width (std::size_t width)
Options &	show_positional_help ()
Options &	show_positional_help ()

Public Functions Documentation

function Options [1/2]

inline explicit cxxopts::Options::Options (
    std::string program_name,
    std::string help_string=""
) 

---

function Options [1/2]

inline explicit cxxopts::Options::Options (
    std::string program_name,
    std::string help_string=""
) 

---

function add_option [1/6]

inline void cxxopts::Options::add_option (
    const std::string & group,
    const Option & option
) 

---

function add_option [2/6]

inline void cxxopts::Options::add_option (
    const std::string & group,
    const std::string & s,
    const OptionNames & l,
    std::string desc,
    const std::shared_ptr< const Value > & value,
    std::string arg_help
) 

---

function add_option [3/6]

inline void cxxopts::Options::add_option (
    const std::string & group,
    const std::string & short_name,
    const std::string & single_long_name,
    std::string desc,
    const std::shared_ptr< const Value > & value,
    std::string arg_help
) 

---

function add_option [1/6]

void cxxopts::Options::add_option (
    const std::string & group,
    const Option & option
) 

---

function add_option [2/6]

void cxxopts::Options::add_option (
    const std::string & group,
    const std::string & s,
    const OptionNames & l,
    std::string desc,
    const std::shared_ptr< const Value > & value,
    std::string arg_help
) 

---

function add_option [3/6]

inline void cxxopts::Options::add_option (
    const std::string & group,
    const std::string & short_name,
    const std::string & single_long_name,
    std::string desc,
    const std::shared_ptr< const Value > & value,
    std::string arg_help
) 

---

function add_options [1/4]

inline OptionAdder cxxopts::Options::add_options (
    std::string group=""
) 

---

function add_options [2/4]

inline void cxxopts::Options::add_options (
    const std::string & group,
    std::initializer_list< Option > options
) 

---

function add_options [1/4]

OptionAdder cxxopts::Options::add_options (
    std::string group=""
) 

---

function add_options [2/4]

void cxxopts::Options::add_options (
    const std::string & group,
    std::initializer_list< Option > options
) 

---

function allow_unrecognised_options [1/2]

inline Options & cxxopts::Options::allow_unrecognised_options () 

---

function allow_unrecognised_options [1/2]

inline Options & cxxopts::Options::allow_unrecognised_options () 

---

function custom_help [1/2]

inline Options & cxxopts::Options::custom_help (
    std::string help_text
) 

---

function custom_help [1/2]

inline Options & cxxopts::Options::custom_help (
    std::string help_text
) 

---

function group_help [1/2]

inline const HelpGroupDetails & cxxopts::Options::group_help (
    const std::string & group
) const

---

function group_help [1/2]

const HelpGroupDetails & cxxopts::Options::group_help (
    const std::string & group
) const

---

function groups [1/2]

inline std::vector< std::string > cxxopts::Options::groups () const

---

function groups [1/2]

std::vector< std::string > cxxopts::Options::groups () const

---

function help [1/2]

inline std::string cxxopts::Options::help (
    const std::vector< std::string > & groups={},
    bool print_usage=true
) const

---

function help [1/2]

std::string cxxopts::Options::help (
    const std::vector< std::string > & groups={},
    bool print_usage=true
) const

---

function parse [1/2]

inline ParseResult cxxopts::Options::parse (
    int argc,
    const char *const * argv
) 

---

function parse [1/2]

ParseResult cxxopts::Options::parse (
    int argc,
    const char *const * argv
) 

---

function parse_positional [1/8]

inline void cxxopts::Options::parse_positional (
    std::string option
) 

---

function parse_positional [2/8]

inline void cxxopts::Options::parse_positional (
    std::vector< std::string > options
) 

---

function parse_positional [3/8]

inline void cxxopts::Options::parse_positional (
    std::initializer_list< std::string > options
) 

---

function parse_positional [4/8]

template<typename Iterator>
inline void cxxopts::Options::parse_positional (
    Iterator begin,
    Iterator end
) 

---

function parse_positional [1/8]

void cxxopts::Options::parse_positional (
    std::string option
) 

---

function parse_positional [2/8]

void cxxopts::Options::parse_positional (
    std::vector< std::string > options
) 

---

function parse_positional [3/8]

void cxxopts::Options::parse_positional (
    std::initializer_list< std::string > options
) 

---

function parse_positional [4/8]

template<typename Iterator>
inline void cxxopts::Options::parse_positional (
    Iterator begin,
    Iterator end
) 

---

function positional_help [1/2]

inline Options & cxxopts::Options::positional_help (
    std::string help_text
) 

---

function positional_help [1/2]

inline Options & cxxopts::Options::positional_help (
    std::string help_text
) 

---

function program [1/2]

inline const std::string & cxxopts::Options::program () const

---

function program [1/2]

inline const std::string & cxxopts::Options::program () const

---

function set_tab_expansion [1/2]

inline Options & cxxopts::Options::set_tab_expansion (
    bool expansion=true
) 

---

function set_tab_expansion [1/2]

inline Options & cxxopts::Options::set_tab_expansion (
    bool expansion=true
) 

---

function set_width [1/2]

inline Options & cxxopts::Options::set_width (
    std::size_t width
) 

---

function set_width [1/2]

inline Options & cxxopts::Options::set_width (
    std::size_t width
) 

---

function show_positional_help [1/2]

inline Options & cxxopts::Options::show_positional_help () 

---

function show_positional_help [1/2]

inline Options & cxxopts::Options::show_positional_help () 

---

---

The documentation for this class was generated from the following file /home/friedel/devel/ILLIXR-clean/plugins/zed/capture/cxxopts.hpp