class options_description

Declaration

class options_description { /* full declaration omitted */ };

Description

A set of option descriptions. This provides convenient interface for adding new option (the add_options) method, and facilities to search for options by name. See @ref"here" for option adding interface discussion.

Declared at: libs/pika/program_options/include/pika/program_options/options_description.hpp:177

Member Variables

public static const unsigned int m_default_line_length

Method Overview

• public void add(std::shared_ptr<option_description> desc)
• public pika::program_options::options_description & add(const pika::program_options::options_description & desc)
• public pika::program_options::options_description_easy_init add_options()
• public const pika::program_options::option_description & find(const std::string & name, bool approx, bool long_ignore_case = false, bool short_ignore_case = false) const
• public const pika::program_options::option_description * find_nothrow(const std::string & name, bool approx, bool long_ignore_case = false, bool short_ignore_case = false) const
• public std::size_t get_option_column_width() const
• public const std::vector<std::shared_ptr<option_description>> & options() const
• public options_description(unsigned int line_length = m_default_line_length, unsigned int min_description_length = m_default_line_length / 2)
• public options_description(const std::string & caption, unsigned int line_length = m_default_line_length, unsigned int min_description_length = m_default_line_length / 2)
• public void print(std::ostream & os, std::size_t width = 0) const

Methods

void add(std::shared_ptr<option_description> desc)

Description

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

Declared at: libs/pika/program_options/include/pika/program_options/options_description.hpp:198

Parameters

std::shared_ptr<option_description> desc

pika::program_options::options_description& add(
    const pika::program_options::
        options_description& desc)

Description

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.

Declared at: libs/pika/program_options/include/pika/program_options/options_description.hpp:205

Parameters

const pika::program_options::options_description& desc

pika::program_options::
    options_description_easy_init
    add_options()

Description

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.

Declared at: libs/pika/program_options/include/pika/program_options/options_description.hpp:218

const pika::program_options::option_description&
find(const std::string& name,
     bool approx,
     bool long_ignore_case = false,
     bool short_ignore_case = false) const

Declared at: libs/pika/program_options/include/pika/program_options/options_description.hpp:220

Parameters

const std::string& name

bool approx

bool long_ignore_case = false

bool short_ignore_case = false

const pika::program_options::option_description*
find_nothrow(const std::string& name,
             bool approx,
             bool long_ignore_case = false,
             bool short_ignore_case = false) const

Declared at: libs/pika/program_options/include/pika/program_options/options_description.hpp:224

Parameters

const std::string& name

bool approx

bool long_ignore_case = false

bool short_ignore_case = false

std::size_t get_option_column_width() const

Description

Find the maximum width of the option column, including options in groups.

Declared at: libs/pika/program_options/include/pika/program_options/options_description.hpp:209

const std::vector<
    std::shared_ptr<option_description>>&
options() const

Declared at: libs/pika/program_options/include/pika/program_options/options_description.hpp:228

options_description(
    unsigned int line_length =
        m_default_line_length,
    unsigned int min_description_length =
        m_default_line_length / 2)

Description

Creates the instance.

Declared at: libs/pika/program_options/include/pika/program_options/options_description.hpp:183

Parameters

unsigned int line_length = m_default_line_length

unsigned int min_description_length = m_default_line_length / 2

options_description(
    const std::string& caption,
    unsigned int line_length =
        m_default_line_length,
    unsigned int min_description_length =
        m_default_line_length / 2)

Description

Creates the instance. The 'caption' parameter gives the name of this 'options_description' instance. Primarily useful for output. The 'description_length' specifies the number of columns that should be reserved for the description text; if the option text encroaches into this, then the description will start on the next line.

Declared at: libs/pika/program_options/include/pika/program_options/options_description.hpp:192

Parameters

const std::string& caption

unsigned int line_length = m_default_line_length

unsigned int min_description_length = m_default_line_length / 2

void print(std::ostream& os,
           std::size_t width = 0) const

Description

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

Declared at: libs/pika/program_options/include/pika/program_options/options_description.hpp:238

Parameters

std::ostream& os

std::size_t width = 0