class positional_options_description

Declaration

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

Description

Describes positional options. The class allows to guess option names for positional options, which are specified on the command line and are identified by the position. The class uses the information provided by the user to associate a name with every positional option, or tell that no name is known. The primary assumption is that only the relative order of the positional options themselves matters, and that any interleaving ordinary options don't affect interpretation of positional options. The user initializes the class by specifying that first N positional options should be given the name X1, following M options should be given the name X2 and so on.

Declared at: libs/pika/program_options/include/pika/program_options/positional_options.hpp:33

Method Overview

Methods

pika::program_options::
    positional_options_description&
    add(const char* name, int max_count)

Description

Species that up to 'max_count' next positional options should be given the 'name'. The value of '-1' means 'unlimited'. No calls to 'add' can be made after call with 'max_value' equal to '-1'.

Declared at: libs/pika/program_options/include/pika/program_options/positional_options.hpp:43

Parameters

const char* name
int max_count

unsigned int max_total_count() const

Description

Returns the maximum number of positional options that can be present. Can return (numeric_limits <unsigned >::max)() to indicate unlimited number.

Declared at: libs/pika/program_options/include/pika/program_options/positional_options.hpp:48

const std::string& name_for_position(
    unsigned int position) const

Description

Returns the name that should be associated with positional options at 'position'. Precondition: position < max_total_count()

Declared at: libs/pika/program_options/include/pika/program_options/positional_options.hpp:54

Parameters

unsigned int position

positional_options_description()

Declared at: libs/pika/program_options/include/pika/program_options/positional_options.hpp:36