options_description();

Creates the instance.

options_description(const std::string & caption);

Creates the instance. The 'caption' parameter gives the name of this 'options_description' instance. Primarily useful for output.

void add(shared_ptr< option_description > desc) ;

Adds new variable description. Throws duplicate_variable_error if either short or long name matches that of already present one.

options_description & add(const options_description & desc) ;

Adds a group of option description. This has the same effect as adding all option_descriptions in 'desc' individually, except that output operator will show a separate group. Returns *this.

options_description_easy_init add_options() ;

Returns an object of implementation-defined type suitable for adding options to options_description. The returned object will have overloaded operator() with parameter type matching 'option_description' constructors. Calling the operator will create new option_description instance and add it.

unsigned count(const std::string & name) const;

Count the number of option descriptions with given name. Returns 0 or 1. The 'name' parameter can be either name of long option, and short option prefixed by '-'.

unsigned count_approx(const std::string & prefix) const;

Count the number of descriptions having the given string as prefix. This makes sense only for long options.

const option_description & find(const std::string & name) const;

Returns description given a name.

Requires: count(name) == 1

const option_description & find_approx(const std::string & prefix) const;

Returns description given a prefix. Throws

Requires: count_approx(name) == 1

std::set< std::string > keys() const;

std::set< std::string > primary_keys() const;

For each option description stored, contains long name if not empty, if it is empty, short name is returned.

std::set< std::string > approximations(const std::string & prefix) const;

void print(std::ostream & os) const;

Output 'desc' to the specified stream, calling 'f' to output each option_description element.

approximation_range find_approximation(const std::string & prefix) const;