class basic_parsed_options

Declaration

template <class Char>
class basic_parsed_options { /* full declaration omitted */ };

Description

Results of parsing an input source. The primary use of this class is passing information from parsers component to value storage component. This class does not makes much sense itself.

Declared at: libs/pika/program_options/include/pika/program_options/parsers.hpp:32

Member Variables

public std::vector<basic_option<Char>> options

Options found in the source.

public const pika::program_options::options_description* description

Options description that was used for parsing. Parsers should return pointer to the instance of option_description passed to them, and issues of lifetime are up to the caller. Can be NULL.

public int m_options_prefix

Mainly used for the diagnostic messages in exceptions. The canonical option prefix for the parser which generated these results, depending on the settings for basic_command_line_parser::style() or cmdline::style(). In order of precedence of command_line_style enums: allow_long allow_long_disguise allow_dash_for_short allow_slash_for_short

Method Overview

• public basic_parsed_options<Char>(const pika::program_options::options_description * xdescription, int options_prefix = 0)

Methods

basic_parsed_options<Char>(
    const pika::program_options::
        options_description* xdescription,
    int options_prefix = 0)

Declared at: libs/pika/program_options/include/pika/program_options/parsers.hpp:35

Parameters

const pika::program_options::options_description* xdescription

int options_prefix = 0