class untyped_value

Declaration

class untyped_value : public value_semantic_codecvt_helper { /* full declaration omitted */ };

Description

Class which specifies a simple handling of a value: the value will have string type and only one token is allowed.

Declared at: libs/pika/program_options/include/pika/program_options/value_semantic.hpp:125

Inherits from: value_semantic_codecvt_helper

Method Overview

Methods

bool apply_default(pika::any_nonser&) const

Description

Does nothing.

Declared at: libs/pika/program_options/include/pika/program_options/value_semantic.hpp:157

Parameters

pika::any_nonser& 

bool is_composing() const

Description

Returns true if values from different sources should be composed. Otherwise, value from the first source is used and values from other sources are discarded.

Declared at: libs/pika/program_options/include/pika/program_options/value_semantic.hpp:138

bool is_required() const

Description

Returns true if value must be given. Non-optional value

Declared at: libs/pika/program_options/include/pika/program_options/value_semantic.hpp:143

unsigned int max_tokens() const

Description

The maximum number of tokens for this option that should be present on the command line.

Declared at: libs/pika/program_options/include/pika/program_options/value_semantic.hpp:136

unsigned int min_tokens() const

Description

The minimum number of tokens for this option that should be present on the command line.

Declared at: libs/pika/program_options/include/pika/program_options/value_semantic.hpp:135

std::string name() const

Description

Returns the name of the option. The name is only meaningful for automatic help message.

Declared at: libs/pika/program_options/include/pika/program_options/value_semantic.hpp:133

void notify(const pika::any_nonser&) const

Description

Does nothing.

Declared at: libs/pika/program_options/include/pika/program_options/value_semantic.hpp:163

Parameters

const pika::any_nonser& 

untyped_value(bool zero_tokens = false)

Declared at: libs/pika/program_options/include/pika/program_options/value_semantic.hpp:128

Parameters

bool zero_tokens = false

void xparse(pika::any_nonser& value_store,
            const std::vector<std::string>&
                new_tokens) const

Description

If 'value_store' is already initialized, or new_tokens has more than one elements, throws. Otherwise, assigns the first string from 'new_tokens' to 'value_store', without any modifications.

Declared at: libs/pika/program_options/include/pika/program_options/value_semantic.hpp:153

Parameters

pika::any_nonser& value_store
const std::vector<std::string>& new_tokens